Difference between revisions of "Template:VALT 5.6 Permissions - Specifications"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>__NOTOC__</noinclude> | <noinclude>__NOTOC__</noinclude> | ||
{{Section | title = <h1>Users & Groups</h1> | content = | {{Section | title = <h1>Users & Groups</h1> | content = | ||
| − | The VALT Software is compromised of 7 main sections. <b>Home</b> | + | The VALT Software is compromised of 7 main sections. |
| + | *<b>[[#General|Home]]</b> | ||
| + | *<b>[[#Observe|Observe]]</b> | ||
| + | *<b>[[#Review|Review]]</b> | ||
| + | *<b>[[#Schedule|Schedule]]</b> | ||
| + | *<b>[[#Reports|Reports]]</b> | ||
| + | *<b>[[#Upload|Uploads]]</b> | ||
| + | *<b>[[#Admin|Admin]]</b> | ||
| + | |||
| + | Access to these sections, and their associated features, can be controlled at two distinct levels within the software: the <b>group level</b> and the <b>user level</b>. | ||
| Line 86: | Line 95: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 283: | Line 292: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 453: | Line 462: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 492: | Line 501: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 574: | Line 583: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 613: | Line 622: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 739: | Line 748: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[#Users & Groups | ↑ back to Users & Groups]] | |
<hr> | <hr> | ||
| Line 753: | Line 762: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Rooms</td> | <td class="permission">Rooms</td> | ||
| − | <td class="description"> | + | <td class="description">Specify what room(s) may be viewed for live observation.</td> |
<td>X</td> | <td>X</td> | ||
<td>X</td> | <td>X</td> | ||
| Line 759: | Line 768: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Video Access</td> | <td class="permission">Video Access</td> | ||
| − | <td class="description"> | + | <td class="description">Specify whose videos may be viewed in video playback.</td> |
<td>X</td> | <td>X</td> | ||
<td>X</td> | <td>X</td> | ||
| Line 765: | Line 774: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Default Retention Rule</td> | <td class="permission">Default Retention Rule</td> | ||
| − | <td class="description"></td> | + | <td class="description">Specify how long videos are retained in VALT by days, hours, minutes, or until a specified date, or keep videos for forever.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 771: | Line 780: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">I/O Record Name</td> | <td class="permission">I/O Record Name</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the default recording name used for recordings initiated using the start/stop button accessory. </td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 777: | Line 786: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Max Record Duration</td> | <td class="permission">Max Record Duration</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the maximum duration a recording may last in minutes as a failsafe if a user forgets to stop recording.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Schedule View</td> | <td class="permission">Schedule View</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the Schedule page default to display scheduled recordings in a calendar view or a list view.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 788: | Line 797: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Reports View</td> | <td class="permission">Reports View</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the Reports page default to display reports in a thumbnail view or a list view.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 794: | Line 803: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Search Results View</td> | <td class="permission">Search Results View</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the Review page default to display videos in a thumbnail view or a list view.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 800: | Line 809: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Search Results Display Columns</td> | <td class="permission">Search Results Display Columns</td> | ||
| − | <td class="description"></td> | + | <td class="description">Specify which sortable column headings appear in the Review section of VALT</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 806: | Line 815: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Filters</td> | <td class="permission">Filters</td> | ||
| − | <td class="description"></td> | + | <td class="description">Grants access to and shares filters created by one user to other users in the user group.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 812: | Line 821: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Views</td> | <td class="permission">Views</td> | ||
| − | <td class="description"></td> | + | <td class="description">Grants access to and shares views created by one user to other users in the user group.</td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 818: | Line 827: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Restricted Access</td> | <td class="permission">Restricted Access</td> | ||
| − | <td class="description"></td> | + | <td class="description">Restrict access to VALT by day of week and time period(s) (00:00 – 00:00).</td> |
<td>X</td> | <td>X</td> | ||
<td>X</td> | <td>X</td> | ||
| Line 824: | Line 833: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Expiration Date</td> | <td class="permission">Expiration Date</td> | ||
| − | <td class="description"></td> | + | <td class="description">Automatically disable access to VALT on a specific date.</td> |
<td>X</td> | <td>X</td> | ||
<td>X</td> | <td>X</td> | ||
| Line 830: | Line 839: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Review List Period</td> | <td class="permission">Review List Period</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the default number of days-worth of recordings displayed in the Review section of VALT. </td> |
<td>X</td> | <td>X</td> | ||
<td></td> | <td></td> | ||
| Line 836: | Line 845: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Email</td> | <td class="permission">Email</td> | ||
| − | <td class="description"></td> | + | <td class="description">Specify user email address for email reports.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
| Line 842: | Line 851: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Mobile PIN</td> | <td class="permission">Mobile PIN</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set a user’s pin number used to sign in to the BEAM application.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
| Line 848: | Line 857: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Card Number</td> | <td class="permission">Card Number</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the user’s RFID card number, so when they use their card to initiate a recording it identifies them as the author.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
| Line 854: | Line 863: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">SSO/SAML IDP</td> | <td class="permission">SSO/SAML IDP</td> | ||
| − | <td class="description"></td> | + | <td class="description">Specify which IdP a user is authenticating to and pulling attributes from.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
| Line 860: | Line 869: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Display Name</td> | <td class="permission">Display Name</td> | ||
| − | <td class="description"></td> | + | <td class="description">Specify how the user’s name appears in VALT. May be different than their user ID.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
| Line 866: | Line 875: | ||
<tr class="lvl_2"> | <tr class="lvl_2"> | ||
<td class="permission">Control Type</td> | <td class="permission">Control Type</td> | ||
| − | <td class="description"></td> | + | <td class="description">Set the default control type, compass or point and click, for Pan-Tilt-Zoom camera control in VALT.</td> |
<td></td> | <td></td> | ||
<td>X</td> | <td>X</td> | ||
Latest revision as of 08:59, 15 May 2023
Users & Groups
The VALT Software is compromised of 7 main sections.
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.
Group Level
At the core of our permission structure, the majority of access permissions are defined at the group level. By establishing permission settings at this level, you can streamline the management process and ensure consistent access controls for users within the same group.
User Level
Permissions defined at the group level are automatically inherited by the individual users assigned to those groups, simplifying the administration of permissions.
In addition to the group-level permissions, our software allows for further customization at the individual user level. This means that specific access permissions can be fine-tuned to cater to unique requirements, providing an extra layer of control over user privileges.
Group Level Permissions
Here are lists of the permissions 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.
General
This section applies to buttons or notifications that are system wide.
| Permission | Description | Group | User | |
|---|---|---|---|---|
| ↓ General | Grants access to the features within the General Section. | X | ||
| Home | Grants user access to Home section. | X | ||
| Alert | Shows alert notification banner. | X | ||
| Edit Profile | Grants the ability for a user to change their display name and email. | X | ||
| Change Password | Grants the ability for a user to change their password if the account is a local user type. | X | ||
| Notifications | Show notifications in upper right corner when actions within VALT are performed. | X | ||
Observe
This section of the software is used to view live sessions and create recordings.
| Permission | Description | Group | User | |||
|---|---|---|---|---|---|---|
| ↓ Observe | Grants users access to the review section. | X | ||||
| ↓ 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. | X | ||||
| Start | Grants the ability to start recordings. | X | ||||
| Prepare | Grants the ability for a user to set up a recording without starting it and then come back later to just click start on the recording. | X | ||||
| ↓ Evaluation | Grants the ability to fill out an evaluation form at the beginning or during a recording. | X | ||||
| View Option Values | Grants the ability to see evaluation option values at the beginning or during a recording. | X | ||||
| View Field Values | Grants the ability to see evaluation field values at the beginning or during a recording. | X | ||||
| View Total Value | Grants the ability to see evaluation total values at the beginning or during a recording. | X | ||||
| Sharing | Grants the ability to change the permissions on an individual video. This can be used to grant access to the video to users who could not normally see that video. It cannot be used to restrict access to a video from a user who would normally have access. | X | ||||
| Change Author | Grants the ability to change the author of the recording at the beginning or during the recording process. | X | ||||
| Retention | Grants the ability to change the retention from the author defaults at the beginning or during the recording process. | X | ||||
| Stop All Authors | Grants the ability to stop recordings a user has access to authored by another user. | X | ||||
| ↓ Stop Confirmation | If checked this will provide a confirmation prompt whenever the user presses the stop button to stop a recording. | X | ||||
| All Authors | Grants the ability for a user to pause other users recordings. | X | ||||
| Resume All Authors | Grants the ability for a user to resume other users paused recordings. | X | ||||
| Add Markers | Grants the ability to add markers while a video is recording. | X | ||||
| ↓ Options | Grants the ability to make changes to a recording while a recording is in progress. | X | ||||
| All Authors | Grants the ability to make changes to other users recordings while in progress. | X | ||||
| Create Sharing Link | Grants the ability to generate a link that will grant direct access to a video. This link can be distributed to people without access to Valt. This permission also allows for the user to disable existing links. | X | ||||
| ↓ Lock | Grants the ability to lock a room so it cannot be used for recording or live observation until unlocked. | X | ||||
| Unlock All Users | Grants the ability to unlock rooms locked by other users. | X | ||||
| ↓ Views | Grants the ability to save groups of cameras as a view so they can easily be called up together for live observation. | X | ||||
| Recording | Grants the ability to record views. | X | ||||
| Talkback | Grants the ability to use the talkback feature of the software which allows the user to use their computer microphone to communicate with the subjects in the room through either a speaker or earbud. | X | ||||
| ↓ PTZ | This section applies only to PTZ short for pan tilt and zoom enabled cameras. | X | ||||
| All Authors | Grants the ability to control the pan, tilt, and zoom of a camera with PTZ capabilities while that camera is currently being recorded by another user. | X | ||||
| Control | Grants the ability to control the pan, tilt, and zoom of a camera with PTZ capabilities. | X | ||||
| ↓ Presets | Grants the ability to move the camera to a previously designated position using the preset dropdown. | X | ||||
| Add/Delete | Grants the ability to create and delete presets. | X | ||||
Review
This section of the software is used to view previously recorded sessions, update metadata, download, and delete existing videos.
| Permission | Description | Group | User | ||
|---|---|---|---|---|---|
| ↓ Review | This section of the software is used to view previously recorded sessions, update metadata, download, and delete existing videos. | X | |||
| Edit Information | Grants the ability to change the information filled in when starting the recording associated with a video. | X | |||
| ↓ Evaluation | Grants the ability to view the evaluation form. | X | |||
| View Option Values | Grants the ability to see evaluation option values. | X | |||
| View Field Values | Grants the ability to see evaluation field values. | X | |||
| View Total Value | Grants the ability to see evaluation total values. | X | |||
| Edit | Grants the ability to edit the evaluation. | X | |||
| ↓ Edit Sharing | Grants the ability to change the permissions on an individual video. This can be used to grant access to the video to users who could not normally see that video. It cannot be used to restrict access to a video from a user who would normally have access. | X | |||
| Link | Grants the ability to generate a link that will grant direct access to a video. This link can be distributed to people without access to Valt. This permission also allows for the user to disable existing links. | X | |||
| Change Author | Grants the ability to assign a previously recorded video to another user. This is particularly useful when starting and stopping recordings with a button as recordings started this way will be assigned to a generic user. | X | |||
| Edit Retention | Grants the ability to adjust the retention period on an individual video. | X | |||
| Delete | Grants the ability to delete recordings. | X | |||
| ↓ Download | Grants the ability to download recordings. | X | |||
| Audio | Grants the ability for the user to create and download an audio only version of the recording. | X | |||
| Multiview | Grants the ability for the user to create and download a video with up to four camera angles. | X | |||
| Add Transcript | Grants the ability for the user to add a camera from the recording to a transcription queue. | X | |||
| ↓ Markers | Markers are used to add information to specific points within a recording. | X | |||
| View All Authors | Grants the ability to view the markers created by other users. | X | |||
| Add | Grants the ability to add markers to a prerecorded video. | X | |||
| Edit | Grants the ability to edit existing markers. | X | |||
| Remove | Grants the ability to delete an existing marker. | X | |||
| Overlay | Grants the ability for the name of the marker to be overlaid on the recording for the user when the recording is being played. | X | |||
| ↓ Tools | Grants access to the tools button within review. | X | |||
| Clip | Grants the ability to create clips from existing recordings. This creates a new video and does not affect the original video. | X | |||
| Redact | Grants the ability to delete a section of video from existing recordings. This creates a new video without the redacted session and does not affect the original video. | X | |||
Upload
Allows users to upload videos to the VALT software, files must be MP4/MOV.
| Permission | Description | Group | User | |
|---|---|---|---|---|
| ↓ Upload | Grants users access to the upload section. | X | ||
| Sharing | Grants the ability to change the permissions on an individual video. This can be used to grant access to the video to users who could not normally see that video. It cannot be used to restrict access to a video from a user who would normally have access. | X | ||
| Change Author | Grants the ability to change the author of the uploaded video. | X | ||
| Retention | Grants the ability to change the retention from the author defaults. | X | ||
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.
| Permission | Description | Group | User | ||
|---|---|---|---|---|---|
| ↓ Schedule | Grants users access to the schedule section. | X | |||
| View All Authors | Grants the ability for a user to view the schedules created by other users. | X | |||
| Add | Grants the ability to create both one time and recurring schedules. | X | |||
| Exceptions | Grants the ability to create an exception, such as Christmas day, where recurring schedules will not occur. | X | |||
| ↓ Edit | Grants the ability to edit existing schedules. | X | |||
| All Authors | Grants the ability for a user to edit the schedules created by other users. | X | |||
| Delete | Grants the ability to delete existing schedules. | X | |||
| Sharing | Grants the ability to change the permissions on all videos created by a particular schedule. This can be used to grant access to the video to users who could not normally see that video. It cannot be used to restrict access to a video from a user who would normally have access. | X | |||
| Change Author | Grants the ability for a user to change the author of a schedule. This will also affect the author of the recordings the schedule generate. | X | |||
| Retention | Grants the ability adjust the retention period on all videos created by a particular schedule. | X | |||
| Control | Grants the ability to configure a preset for PTZ cameras when setting up a schedule. This allows a user to force the camera to change to a predesignated position when the recording starts. | X | |||
Reports
These settings allows the users to generate simple statistical reports about usage of the VALT system.
| Permission | Description | Group | User | |
|---|---|---|---|---|
| ↓ Reports | Grants users access to the resports section. | X | ||
| Add Report | Grants the ability to generate new reports. | X | ||
| Edit Report | Grants the ability to change the author of the uploaded video. | X | ||
| Delete Report | Grants the ability to change the retention from the author defaults. | X | ||
Admin
Grants the ability for a user to view general system statistics software version, licenses, storage amount, ect.
| Permission | Description | Group | User | |||
|---|---|---|---|---|---|---|
| ↓ Admin | Grants users access to the Admin tab. | X | ||||
| ↓ General | Grants user access to General section within Admin. | X | ||||
| Software Information | Grants access to the software information which includes software version, software type, number of device licenses and a link to database management. | X | ||||
| Email Settings | Grants access to email configuration settings. | X | ||||
| Media Servers | Grants access to media server list, this displays storage remaining and has a link to media server management portal. | X | ||||
| Customization | Grants access to customization section, this allows someone to customize the images and links associated with the login page. | X | ||||
| ↓ Users & Groups | Grants the ability for the user to administer users and groups and give access rights. | X | ||||
| ↓ LDAP | Grants to the LDAP section. | X | ||||
| User Import | Grants access to search and add users on a per user basis. | X | ||||
| Servers | Grants access to view and configure LDAP servers within the system. | X | ||||
| Sync Schedules | Grants access to view and configure automatic LDAP sync schedules. | X | ||||
| SSO | Grants the ability for the user to setup SAML SSO. | X | ||||
| Templates | Grants the ability for a user to configure marker and information templates. | X | ||||
| Rooms & Cameras | Grants the ability to add, modify or change rooms or cameras. | X | ||||
| Media Servers | Grants the ability to add, modify or change media servers. | X | ||||
| Node Servers | Grants the ability to add, modify or change node servers. | X | ||||
| Transcription | Grants the ability to add, modify or change transcription service. | X | ||||
| Logs | Grants the ability for the user to view logs from the system. | X | ||||
Group and User Level
| Permission / Setting | Description | Group | User |
|---|---|---|---|
| Rooms | Specify what room(s) may be viewed for live observation. | X | X |
| Video Access | Specify whose videos may be viewed in video playback. | X | X |
| Default Retention Rule | Specify how long videos are retained in VALT by days, hours, minutes, or until a specified date, or keep videos for forever. | X | |
| I/O Record Name | Set the default recording name used for recordings initiated using the start/stop button accessory. | X | |
| Max Record Duration | Set the maximum duration a recording may last in minutes as a failsafe if a user forgets to stop recording. | X | |
| Schedule View | Set the Schedule page default to display scheduled recordings in a calendar view or a list view. | X | |
| Reports View | Set the Reports page default to display reports in a thumbnail view or a list view. | X | |
| Search Results View | Set the Review page default to display videos in a thumbnail view or a list view. | X | |
| Search Results Display Columns | Specify which sortable column headings appear in the Review section of VALT | X | |
| Filters | Grants access to and shares filters created by one user to other users in the user group. | X | |
| Views | Grants access to and shares views created by one user to other users in the user group. | X | |
| Restricted Access | Restrict access to VALT by day of week and time period(s) (00:00 – 00:00). | X | X |
| Expiration Date | Automatically disable access to VALT on a specific date. | X | X |
| Review List Period | Set the default number of days-worth of recordings displayed in the Review section of VALT. | X | |
| Specify user email address for email reports. | X | ||
| Mobile PIN | Set a user’s pin number used to sign in to the BEAM application. | X | |
| Card Number | Set the user’s RFID card number, so when they use their card to initiate a recording it identifies them as the author. | X | |
| SSO/SAML IDP | Specify which IdP a user is authenticating to and pulling attributes from. | X | |
| Display Name | Specify how the user’s name appears in VALT. May be different than their user ID. | X | |
| Control Type | Set the default control type, compass or point and click, for Pan-Tilt-Zoom camera control in VALT. | X |
