Difference between revisions of "IVS Wiki:VALT Permissions - Specifiactions"

From IVS Wiki
Jump to: navigation, search
 
(25 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
<h1>Access Control</h1>
 
<h1>Access Control</h1>
  
{{Float | additional_styles = width:25% | content =  
+
{{Float | additional_styles = width:25%;padding-bottom:15px | content =  
 
<div>
 
<div>
 
#{{img - icon | file = Homepage.png | width = 16px}} <strong>[[VALT Manual Home| Home]]</strong>
 
#{{img - icon | file = Homepage.png | width = 16px}} <strong>[[VALT Manual Home| Home]]</strong>
Line 15: Line 15:
  
 
<div style="width: 70%">
 
<div style="width: 70%">
The [https://www.ipivs.com/products/valt-software VALT Software] is compromised of {{img - tooltip | text = 6 main sections | file = VALT 6-4-18 Users&Groups 01.png | width = 1100px}}.  
+
The [https://www.ipivs.com/products/valt-software VALT Software] is compromised of {{img - tooltip | text = 6 main sections | file = VALT 6-4-18 Users&Groups 01.png | width = 700px}}.  
  
  
<b>Access to these sections</b>, and their associated features, can be <b>controlled at two distinct levels</b> within the software: the [[#Group Level|group level]] and the [[#User Level|user level]].  
+
<b>Access to these sections</b>, and their associated features, can be <b>controlled at two distinct levels</b> within the software: the group level and the user level.  
 
</div>
 
</div>
 +
 +
{{hr - 2}}
 +
 +
Outside of the core 6 sections found within the main navigation, there are two additional permissions that can be revoked or granted.
 +
# [[BEAM Main Page|BEAM]]
 +
# [[VALT API|API]]
  
  
 +
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
Line 32: Line 39:
 
{{img - resize | file = VALT 6-4-18 Users&Groups 02.png}}
 
{{img - resize | file = VALT 6-4-18 Users&Groups 02.png}}
  
 +
 +
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
{{Manual lvl 3| title = Users | content =  
+
{{Manual lvl 3 | title = Users | content =  
  
 
Rights defined at the group level are automatically inherited by the individual users assigned to those groups, simplifying the administration of rights.
 
Rights defined at the group level are automatically inherited by the individual users assigned to those groups, simplifying the administration of rights.
Line 41: Line 50:
 
}}
 
}}
  
 +
 +
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
{{Manual lvl 2 | title = Permission Model | content = }}
+
{{Manual lvl 2 | title = Rights | content = }}
{{Manual lvl 3 | title = Rights | content = }}
+
{{Manual lvl 3 | title = How They're Applied  | content =  
{{Manual lvl 4 | title = Group Level | content =
+
<dl>
Here are lists of the {{img - tooltip | text = rights | file = VALT 6-4-18 Users&Groups 03.png | width = 1100px}} within VALT and the corresponding access they grant. The chart below illustrates whether each permission can be configured at the group level, user level, or both.
+
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Group-Level</dt>
 +
<dd>Here are lists of the {{img - tooltip | text = rights | file = VALT 6-4-18 Users&Groups 03.png | width = 900px}} within VALT and the corresponding access they grant. The tables below illustrate whether each permission can be configured at the group level, user level, or both.</dd>
  
<dl>
 
<dt>General</dt>
 
<dd>Grants access to the features within the General section.</dd>
 
{{Aside - Helpful | content = This section applies to buttons or notifications that are <b>system wide</b>.}}
 
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Observe</dt>
+
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">User-Level Override</dt>
<dd>This section of the software is used to view live sessions and create recordings.</dd>
+
 
 +
<dd>While permissions are primarily configured at the group-level, additional permissions can be granted at the user-level.
 +
{{Aside | content = Permissions can only be granted at this level. Permissions are revoked at the group-level.}}</dd>
 +
</dl>
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Review</dt>
+
 
<dd>This section of the software is used to view previously recorded sessions, update metadata, download, and delete existing videos.</dd>
+
{{Manual lvl 3 | title = Available Rights | content =
 +
The following section aims to highlight a few key permissions in each section that one might want to consider enabling/disabling. If you want to see a more comprehensive list of permissions, [[Permissions | click here]].
 +
 
 +
{{hr}}
 +
 
 +
<dl>
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">General</dt>
 +
<dd>
 +
Grants access to the features within the General section.
 +
{{Aside - Helpful | content = This section applies to buttons or notifications that are <b>system wide</b>.}}
 +
</dd>
 +
</dl>
 +
 
 +
{{Section | title = Sample of General Rights | content =
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>General</strong> | text = Grants access to the features within the General Section}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Home</strong> | text = Grants user access to Home section}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Edit Profile</strong> | text = Grants the ability for a user to change their display name and email}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Change Password</strong> | text = Grants the ability for a user to change their password if the account is a local user type}}
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Upload</dt>
+
 
<dd>Allows users to upload videos to the VALT software. Files must be MP4 or MOV.</dd>
+
<dl>
 +
 
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Observe</dt>
 +
<dd>
 +
This section of the software is used to view live sessions and create recordings.
 +
</dd>
 +
</dl>
 +
 
 +
{{Section | title = Sample of Observe Rights {{Float | content = {{img - icon | file = Observe.png | width = 18px}} }} | content =
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Recording</strong> | text = These settings are used in the Observe section of the software. To start a recording a user must also have access to the live observation}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Start</strong> | text = Grants the ability to start recordingings}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Comments</strong> | text = Comments are used to add information to specific points within a recording}}
 +
{{Level 3 Custom | icon = {{Checkbox - VALT}} | name = <strong>Add</strong> | text = Grants the ability to add comments to a recording}}
 +
{{Level 3 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Delete</strong> | text = Grants the ability to a user to delete their comments}}
 +
{{Level 4 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>All Authors</strong> | text = Grants the ability to delete any existing comments}}
 +
{{Level 3 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Edit</strong> | text = Grants the ability to a user to edit their comments}}
 +
{{Level 4 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>All Authors</strong> | text = Grants the ability to a user to edit any existing comments}}
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Schedule</dt>
+
 
<dd>This section of the software is used to schedule recordings that will take place on a specific date, at a specific time, and will last for a fixed duration.</dd>
+
<dl>
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Review</dt>
 +
<dd>
 +
This section of the software is used to view previously recorded sessions, update metadata, download, and delete existing videos.
 +
</dd>
 +
</dl>
 +
 
 +
{{Section | title = Sample of Review Rights {{Float | content = {{img - icon | file = Review.png | width = 18px}} }} | content =
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Download</strong> | text = Grants the ability to download recordings}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Comments</strong> | text = Comments are used to add information to specific points within a recording}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Add</strong> | text = Grants the ability to add comments to a recording}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Delete</strong> | text = Grants the ability to a user to delete their comments}}
 +
{{Level 3 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>All Authors</strong> | text = Grants the ability to delete any existing comments}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Edit</strong> | text = Grants the ability to a user to edit their comments}}
 +
{{Level 3 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>All Authors</strong> | text = Grants the ability to a user to edit any existing comments}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Delete</strong> | text = Grants the ability to delete recordings}}
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Reports</dt>
+
 
<dd>Allows users to generate simple statistical reports about usage of the VALT system.</dd>
+
<dl>
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Schedule</dt>
 +
<dd>
 +
This section of the software is used to schedule recordings that will take place on a specific date, at a specific time, and will last for a fixed duration.
 +
</dd>
 +
</dl>
 +
 
 +
{{Section | title = Sample of Schedule Rights {{Float | content = {{img - icon | file = Schedule.png | width = 18px}} }}| content =
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Add</strong> | text = Grants the ability to create both one time and recurring schedules}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Copy</strong> | text = Grants the ability to copy existing schedules}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Partial}} | name = <strong>Delete</strong> | text = Grants the ability to delete existing schedules}}
 +
{{Level 2 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>All Authors</strong> | text = Grants the ability for a user to delete the schedules created by other users}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Exceptions</strong> | text = Grants the ability to create an exception, such as Christmas day, where recurring schedules will not occur}}
 +
}}
 +
 
 +
{{Top of Page}}
 
{{hr - 2}}
 
{{hr - 2}}
<dt>Settings</dt>
+
 
<dd>Grants the ability for a user to view general system statistics including software version, licenses, and storage amount.</dd>
+
<dl>
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Reports</dt>
 +
<dd>
 +
Allows users to generate simple statistical reports about usage of the VALT system.
 +
</dd>
 
</dl>
 
</dl>
 +
 +
{{Section | title = Sample of Reports Rights  {{Float | content = {{img - icon | file = Reports.png | width = 18px}} }}| content =
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Add</strong> | text = Grants the ability to generate new reports}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Edit</strong> | text = Grants the ability to edit a report after it has been created}}
 +
{{Level 1 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Delete</strong> | text = Grants the ability to delete a report once it is created}}
 
}}
 
}}
  
{{hr}}
+
{{Top of Page}}
 +
{{hr - 2}}
 +
 
 +
<dl>
 +
<dt style="font-size: 18px; font-weight: bold; color: #1f4d78; font-style: italic">Settings</dt>
 +
<dd>Grants the ability for a user to view general system statistics including software version, licenses, and storage amount.</dd>
 +
</dl>
  
{{Section - Expand | title = Sample of General Rights | color = #f6c62a | content =  
+
{{Section | title = Sample of Settings Rights {{Float | content = {{img - icon | file = VALT_Settings.png | width = 18px}} }} | content =  
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>General</strong> | text = Grants access to the features within the General Section.}}
+
{{Level 1 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Users & Groups</strong> | text = Grants the ability for the user to administrate users and groups and give access rights}}
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Home</strong> | text = Grants user access to Home section.}}  
+
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Templates</strong> | text = Grants the ability for a user to configure comment and information templates}}
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Edit Profile</strong> | text = Grants the ability for a user to change their display name and email.}}
+
{{Level 1 Custom | icon = {{Checkbox - VALT}} | name = <strong>Logs</strong> | text = Grants the ability for the user to view logs from the system}}
{{Level 2 Custom | icon = {{Checkbox - VALT}} | name = <strong>Change Password</strong> | text = Grants the ability for a user to change their password if the account is a local user type.}}
+
{{Level 1 Custom | icon = {{Checkbox - VALT Empty}} | name = <strong>Help</strong> | text = Grants the ability to see Help section}}
 +
}}
 +
{{Aside - Helpful | content = For more information on <b>templates</b> [[VALT Manual - Templates|click here]].}}
 
}}
 
}}
  
<h4>Group and User Level</h4>
+
 
 +
{{Top of Page}}
 
</onlyinclude>}}
 
</onlyinclude>}}

Latest revision as of 09:01, 3 June 2026

Access Control

The VALT Software is compromised of 6 main sectionsVALT 6-4-18 Users&Groups 01.png🖼️.


Access to these sections, and their associated features, can be controlled at two distinct levels within the software: the group level and the user level.


Outside of the core 6 sections found within the main navigation, there are two additional permissions that can be revoked or granted.

  1. BEAM
  2. API


⇧ Back to Top


Role Management

User Groups

At the core of our permission structure, the majority of access is defined at the group level. By establishing permission settings at this level, you can streamline management and ensure consistent access controls for users within the same group.

VALT 6-4-18 Users&Groups 02.png


⇧ Back to Top


Users

Rights defined at the group level are automatically inherited by the individual users assigned to those groups, simplifying the administration of rights.

In addition to the group-level rights, our software allows for further customization at the individual user level. This means that specific access rights can be fine-tuned to cater to unique requirements, providing an extra layer of control over user privileges.


⇧ Back to Top


Rights

How They're Applied

Group-Level
Here are lists of the rightsVALT 6-4-18 Users&Groups 03.png🖼️ within VALT and the corresponding access they grant. The tables below illustrate whether each permission can be configured at the group level, user level, or both.

User-Level Override

While permissions are primarily configured at the group-level, additional permissions can be granted at the user-level.

Permissions can only be granted at this level. Permissions are revoked at the group-level.


⇧ Back to Top


Available Rights

The following section aims to highlight a few key permissions in each section that one might want to consider enabling/disabling. If you want to see a more comprehensive list of permissions, click here.


General
Grants access to the features within the General section.
🕮
This section applies to buttons or notifications that are system wide.

Sample of General Rights
General
Grants access to the features within the General Section
⎼⎼⎼┗╴ Home
Grants user access to Home section
⎼⎼⎼┗╴ Edit Profile
Grants the ability for a user to change their display name and email
⎼⎼⎼┗╴ Change Password
Grants the ability for a user to change their password if the account is a local user type


⇧ Back to Top


Observe
This section of the software is used to view live sessions and create recordings.
Sample of Observe Rights
icon
Recording
These settings are used in the Observe section of the software. To start a recording a user must also have access to the live observation
⎼⎼⎼┗╴ Start
Grants the ability to start recordingings
⎼⎼⎼┗╴ Comments
Comments are used to add information to specific points within a recording
⎼⎼⎼⎼⎼⎼┗╴ Add
Grants the ability to add comments to a recording
⎼⎼⎼⎼⎼⎼┗╴ Delete
Grants the ability to a user to delete their comments
⎼⎼⎼⎼⎼⎼⎼⎼⎼┗╴ All Authors
Grants the ability to delete any existing comments
⎼⎼⎼⎼⎼⎼┗╴ Edit
Grants the ability to a user to edit their comments
⎼⎼⎼⎼⎼⎼⎼⎼⎼┗╴ All Authors
Grants the ability to a user to edit any existing comments


⇧ Back to Top


Review
This section of the software is used to view previously recorded sessions, update metadata, download, and delete existing videos.
Sample of Review Rights
icon
Download
Grants the ability to download recordings
Comments
Comments are used to add information to specific points within a recording
⎼⎼⎼┗╴ Add
Grants the ability to add comments to a recording
⎼⎼⎼┗╴ Delete
Grants the ability to a user to delete their comments
⎼⎼⎼⎼⎼⎼┗╴ All Authors
Grants the ability to delete any existing comments
⎼⎼⎼┗╴ Edit
Grants the ability to a user to edit their comments
⎼⎼⎼⎼⎼⎼┗╴ All Authors
Grants the ability to a user to edit any existing comments
Delete
Grants the ability to delete recordings


⇧ Back to Top


Schedule
This section of the software is used to schedule recordings that will take place on a specific date, at a specific time, and will last for a fixed duration.
Sample of Schedule Rights
icon
Add
Grants the ability to create both one time and recurring schedules
Copy
Grants the ability to copy existing schedules
Delete
Grants the ability to delete existing schedules
⎼⎼⎼┗╴ All Authors
Grants the ability for a user to delete the schedules created by other users
Exceptions
Grants the ability to create an exception, such as Christmas day, where recurring schedules will not occur

⇧ Back to Top


Reports
Allows users to generate simple statistical reports about usage of the VALT system.
Sample of Reports Rights
icon
Add
Grants the ability to generate new reports
Edit
Grants the ability to edit a report after it has been created
Delete
Grants the ability to delete a report once it is created

⇧ Back to Top


Settings
Grants the ability for a user to view general system statistics including software version, licenses, and storage amount.
Sample of Settings Rights
icon
Users & Groups
Grants the ability for the user to administrate users and groups and give access rights
Templates
Grants the ability for a user to configure comment and information templates
Logs
Grants the ability for the user to view logs from the system
Help
Grants the ability to see Help section
🕮
For more information on templates click here.


⇧ Back to Top