Skip to content

Organizational Setup

Andrea de Ruvo edited this page Sep 12, 2024 · 1 revision

The Organizational Setup section provides guidelines on how to structure and configure the various entities that make up your organization's hierarchy within the system. This includes setting up applicants, users, groups, roles, and profiles, which are all essential to ensure proper management of access, visibility, and permissions across different parts of the organization. This configuration is fundamental to the way data, processes, and analyses are handled in the system.

Key Concepts

Before diving into the details of how to configure entities, it is important to understand some of the core concepts within the system. These include:

  • Applicants: Entities (typically organizations or departments) that request analyses or use the system's data.
  • Sources: The origins of the data used in the analyses. Sources help track and control the visibility of data.
  • Groups: Collections of users who share similar roles or permissions within the system.
  • Roles: Specialized filters within groups that further refine access to specific data or workflows.
  • Profiles: A combination of applicants, sources, and groups/roles that define a user's permissions and access within the system.

Overview of Organizational Setup

The Organizational Setup is divided into several key areas to facilitate easy management and configuration. Each section represents a different part of the hierarchy or functionality within the organization. Here is an overview of the different components that can be configured:

The Visibility Model defines how data is accessed and managed by different users, groups, and roles. It allows you to control the visibility of specific data sets, species, or workflows based on a user's group and role. The model ensures that users only see and interact with the data that is relevant to their responsibilities.

Sources represent the origins of the data used in the system. This could be a database, web service, or any other informative system. Proper source configuration ensures data is organized and managed effectively, allowing applicants and groups to have access to the correct data.

An Applicant is typically an organization, department, or entity that requests analyses or is responsible for certain datasets. Applicants can be organized hierarchically, with sub-applicants nested under a parent applicant to represent complex organizational structures.

4. Groups

Groups represent collections of users who share the same access rights and permissions. Groups allow administrators to define broad roles and responsibilities for users within the system. Users in a group will inherit the permissions associated with that group.

5. Roles

Roles are filters applied to groups that restrict access to certain species, data types, or workflows. For example, a group may be associated with a specific role that limits their visibility to bacterial data, or another role may limit access to specific menu items. Roles are a way to refine permissions within a group, ensuring more precise control over what users can see and do.

6. Users

In the Users section, administrators can create and manage users, setting up their individual profiles and associating them with specific groups and roles. Proper user management ensures that everyone has access to the right data and functionalities within the system.

This section focuses on associating users with their respective groups. A user can only belong to one group to ensure proper system functionality. Group membership is crucial because it dictates the permissions and access levels each user has.

A Profile is a combination of an applicant, a source, and a group or role that defines the specific access and visibility a user has. Profiles provide granular control over user access, ensuring that each user has a personalized view of the system based on their assigned responsibilities.

This section explains how to configure relationships between applicants, such as defining parent and child applicants. These hierarchical relationships ensure that data is organized according to the organization’s structure, with visibility flowing down the hierarchy from parent applicants to their sub-applicants.

Summary

The Organizational Setup ensures that your organization is properly represented in the system with the correct permissions, roles, and access controls. By carefully configuring each of these entities—applicants, sources, groups, roles, and users—you can ensure that data is handled securely and that each user only has access to the information they need.

For more detailed information on how to configure each of these components, refer to the specific sections linked above.

Clone this wiki locally