Entity

Overview

An Entity is the top-level component in WikiELN's architecture. It represents an organization, project, or any other top-level grouping that owns all the data and resources within it. Entities are designed to provide secure and organized management of files, users, and permissions.

Key Features of an Entity

• File Ownership: All files uploaded within an entity are owned by that entity. Files are not uploaded directly to the entity but through groups associated with the entity.
• Storage Allocation: Each entity is allocated 1 GB of free storage space by default. Additional storage can be purchased as needed.
• User Management: Entities have no limits on the number of users. When a user is added to any group within the entity, they are automatically listed in the entity's user table.
• Admin/Supervisor Roles: Each entity is granted one free admin/supervisor role by default. Additional admin/supervisor seats can be purchased to accommodate more managers.
• Entity Limits and Usage: Entity supervisors can view important metrics such as the number of groups, storage space used, and AI token usage on the entity admin page.

Managing an Entity

Uploading Files

Files are uploaded through groups within an entity, ensuring that all data is properly organized and accessible only to authorized users. Direct uploads to an entity are not allowed, reinforcing the importance of group-based access control.

User Roles

• Supervisor: The default role assigned to manage an entity. Supervisors have access to most of the administrative functions within the entity, including viewing usage limits, monitoring storage, and tracking AI token consumption. Supervisors can also view access logs to monitor who accessed what within the entity.

• Admin: An admin has all the privileges of a supervisor, with the additional ability to manage billing and subscription details for the entity. This distinction ensures that financial management is securely handled.

Entity Admin Page

The entity admin page is the central hub for managing an entity's resources and settings. Here, supervisors and admins can:

• View Limits and Usage: Check the current status of the entity's resources, including storage space, the number of groups, and AI tokens.
• Access Logs: Review detailed logs that track access to files and data within the entity.
• Manage Billing: (Admin only) Handle subscriptions, purchase additional storage, and manage admin/supervisor seats.

Restrictions and Additional Information

• One Free Entity: Users can create only one free entity. This limitation encourages careful planning and organization from the start.
• Additional Resources: While the default settings provide basic functionality, additional resources (such as storage and admin seats) can be purchased to scale the entity according to your needs.

Conclusion

Entities in WikiELN serve as the backbone of your organization’s data management and collaboration. With flexible user roles, scalable storage, and comprehensive admin tools, entities ensure that your team can work efficiently and securely.

Explore other sections of the documentation to learn more about how groups, notebooks, and reports function within your entity.