Difference between revisions of "Template:VALT 6 Manual - Home"

From IVS Wiki
Jump to: navigation, search
 
(72 intermediate revisions by the same user not shown)
Line 1: Line 1:
__TOC__
+
{{Article - Manual | content =  
{{Section | width = 100% | title = <h2>Intro</h2> | content = The <b>Home</b> screen acts as a dashboard for users.
+
<h1>Introduction</h1>
  
{{img left | file = VALT 6.3 Manual-Home 00.png | width = 960px}}
+
{{Manual lvl 2 | title = Accessing the Homepage | content =  
 +
After logging in to the VALT software, you will automatically be directed to the <b>Homepage</b>.  
  
{{Back to VALT 6 Main Menu}}
+
The Homepage provides multiple cards that summarize key aspects of the system and allow you to perform quick actions.
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Home 00.png}}
 
}}
 
}}
  
{{Section | width = 100% | title = <h2>Personal Customization</h2> | content =  
+
{{hr}}
The <b>button menu</b> is used to hide/show the different corresponding sections on the home page.
+
 
 +
<h1>Available Cards</h1>
 +
By default, all cards are visible on the Homepage.
 +
{{Aside - Warning | hue = 50 | content = Depending on your group permissios in the software, your account may be restricted from one or more of these features.}}
 +
<dl class="singleLineHeight">
 +
<dt>{{img - icon | file = Observe.png | width = 16px}} [[#Rooms|Rooms]]</dt>
 +
<dd>An overview of the rooms in your VALT system.</dd>
 +
<dt>{{img - icon | file = Review.png | width = 16px}} [[#Recent Recordings|Recent Recordings]]</dt>
 +
<dd>A list of the most recent recordings created.</dd>
 +
<dt>{{img - icon | file = Schedule.png | width = 16px}} [[#Schedules|Schedules]]</dt>
 +
<dd>Information on upcoming scheduled recordings.</dd>
 +
<dt>{{img - icon | file = Reports.png | width = 20px}} [[#Reports|Reports]]</dt>
 +
<dd>If enabled, this allows you to view various metrics and system reports.</dd>
 +
<dt>{{img - icon | file = Announcement.png | width = 20px}} [[#Announcements|Announcements]]</dt>
 +
<dd>General announcements, if utilized by your organization.</dd>
 +
</dl>
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Personal Customization | content =
 +
By default, all summaries are visible on the Homepage.
 +
 
 +
<div class="myManualList">
 +
#{{img - icon | file = Observe.png | width = 16px}} [[#Rooms|Rooms]]
 +
#{{img - icon | file = Review.png | width = 16px}} [[#Recent Recordings|Recent Recordings]]
 +
#{{img - icon | file = Schedule.png | width = 16px}} [[#Schedules|Schedules]]
 +
#{{img - icon | file = Reports.png | width = 20px}} [[#Reports|Reports]]
 +
#{{img - icon | file = Announcement.png | width = 20px}} [[#Announcements|Announcements]]
 +
</div>
  
{{img with key | width = 960px | file = VALT 6.3 Manual-Home 01.png | list =
+
{{img - resize | file = VALT 6.3 Manual-Home 01.png}}
<li>Rooms</li>
+
 
<li>Recent Recordings</li>
+
{{Aside | content = If you wish to disable any of these views, click on the corresponding icon at the top of the page. {{Try it out | link = https://app.storylane.io/share/p8ybdbb764cw}} }}
<li>Schedules</li>
+
 
<li>Reports</li>
+
{{hr - 2}}
<li>Announcements</li>
+
 
 +
Disabled views will display the icon with a slash through it.
 +
 
 +
<table style="border-spacing: 50px 5px;">
 +
<tr style="font-weight:bold">
 +
<td style="color:#47b648">Enabled</td>
 +
<td style="color:#e91d26">Disabled</td>
 +
</tr>
 +
<tr>
 +
<td>{{img | file = Reports.png | width = 30px}}</td>
 +
<td>{{img | file = Reports Hidden.png | width = 30px}}</td>
 +
</tr>
 +
</table>
 
}}
 
}}
  
 +
{{hr - 2}}
 +
 +
When all buttons are deselected, your Homepage will show as empty. <em>(See image below)</em>
 +
 +
{{img - resize | file = VALT 6.3 Manual-Home 05.png | width = 960px}}
 +
 +
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
{{Aside | content = <b>Quick Tip!</b> Hide sections that are not relevant to you!}}
+
{{Manual lvl 2 | title = Rooms | content =  
 +
This view provides an overview of the rooms in your VALT system. This view will allow you to:
 +
*See the <b>list of rooms</b> you have access to.
 +
*See any <b>ongoing recordings</b>.
 +
*<b>[[#Start a Recording|Start]]</b> / <b>[[#Stop a Recording|Stop]]</b> / <b>[[#Pause a Recording|Pause]]</b> any ongoing recordings.
 +
*Go to the live room.
 +
 
 +
{{hr - 2}}
 +
 
 +
<div class="myManualList">
 +
#Clicking the '<strong>View all</strong>' button will take the user to the [[VALT 6 Observe|observe section]]. <br><em>(See image below)</em>
 +
#When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area. <br><em>(See image below)</em>
 +
#Hovering over a room will reveal associated control buttons.  Pressing the '<strong>REC</strong>' button will open the recording modal to [[#Start a Recording | start a recording]]. <br><em>(See image below)</em>
 +
</div>
 +
}}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Home 06.png}} 
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Aside - Helpful | content = <b>Did you know?</b> You can [[#Start a Recording | start]] and [[#Stop a Recording| stop]] recordings from the Homepage. {{Try it out | link = https://app.storylane.io/share/blbhcupd84qj}} }}
 +
{{Manual lvl 3 | title = Start a Recording | content =
 +
#Hover over a room.
 +
#Click the {{img - icon | file = Record.png}} <strong>REC</strong> icon.
 +
#Enter in the appropriate information for the recording.
 +
#Click the REC button.
 +
}}
 +
 
 +
{{hr - 2}}
  
{{img with key | width = 960px | file = VALT 6.3 Manual-Home 02.png | list = 
+
{{Manual lvl 3 | title = Stop a Recording | content =  
<li><b>Rooms:</b> Shows the top most rooms available to the user and associated room control buttons.</li>
+
#Hover over a room that is currently recording.
:
+
#Press the {{img - icon | file = Stop.png}} <strong>Stop</strong> icon.
<li><b>Recent Recordings:</b> Shows the most recent recordings hovering over a recording brings up the associated control buttons.</li>
 
<li><b>Schedules:</b> Shows any upcoming schedules.</li>
 
<li><b>Reports:</b> Shows a brief list of any reports you created or have access to.</li>
 
<li><b>Announcements:</b> Displays messages assigned to the user’s group that a admin can set or change.</li>
 
 
}}
 
}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Pause a Recording | content =
 +
#Hover over a room that is currently recording.
 +
#Press the {{img - icon | file = Pause.png}} <strong>Pause</strong> icon.
 +
}}
 +
 +
{{Top of Page}}
 +
{{hr - 2}}
 +
 +
{{Manual lvl 2 | title = Recent Recordings | content =
 +
This view provides a list of the most recent recordings created.
 +
 +
<div class="myManualList">
 +
#Clicking the '<strong>View all</strong>' button will take the user to the observe section. <br><em>(See image below)</em>
 +
#When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area. <br><em>(See image below)</em>
 +
#{{img - icon | file = Edit.png}} <b>[[#Edit a Recording|Edit]]</b>: Open the information tab for the recording. <br><em>(See image below)</em>
 +
#{{img - icon | file = Download.png}} <b>[[#Download a Recording|Download]]</b>: Download the recording. <br><em>(See image below)</em>
 +
#{{img - icon | file = Delete.png}} <b>[[#Delete a Recording|Delete]]</b>: Delete the recording. <br><em>(See image below)</em>
 +
</div>
 +
 +
{{img - resize | file = VALT 6.3 Manual-Home 07.png}}
 +
}}
 +
 
{{hr}}
 
{{hr}}
When all buttons are deselected, your Homepage will show as empty.
+
 
{{img left | file = VALT 6.3 Manual-Home 05.png | width = 960px}}
+
{{Manual lvl 3 | title = Edit a Recording | content =
{{Back to VALT 6 Main Menu}}
+
#Hover over a recording.
 +
#Click the {{img - icon | file = Edit.png}} <strong>Edit</strong> icon.
 +
#Make the appropriate edits.
 +
#Click save.
 
}}
 
}}
  
{{Section | width = 100% | title = <h2>Navigation Icons</h2> | content = Here, you will find icons to navigate around the software.
+
{{hr - 2}}
{{Aside - Helpful | content = <b>Did you know?</b> Admins can remove entire sections of the software based on group!}}
 
  
{{img with key | file = VALT 6.3 Manual-Home 03.png | list = 
+
{{Manual lvl 3 | title = Download a Recording | content =
<li>Home</li>
+
#Hover over a recording.
<li>Observe</li>
+
#Click the {{img - icon | file = Download.png}} <strong>Download</strong> icon.
<li>Review</li>
+
#Select where you would like to download the video.
<li>Schedule</li>
+
#:<em>Most browsers will default to your local Downloads folder.</em>
<li>Reports</li>
+
{{Aside - Helpful | content = Videos will be saved as an MP4.}}
<li>Settings</li>
 
 
}}
 
}}
{{Back to VALT 6 Main Menu}}
+
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Delete a Recording | content =
 +
#Hover over a recording.
 +
#Click the {{img - icon | file = Delete.png}} <strong>Delete</strong> icon.
 +
{{Aside - Warning | hue = 0 | content = Deleting a video <b>cannot be undone</b>.}}
 
}}
 
}}
  
{{Section | width = 100% | title = <h2>User Settings and Notifications</h2> | content =
+
{{Top of Page}}
{{img with key | file = VALT 6.3 Manual-Home 04.png | list = 
+
{{hr}}
<li>Account notifications.</li>
+
 
<li>Account settings, VALT alerts, help section, and logout.</li>
+
{{Manual lvl 2 | title = Schedules | content =
 +
This view provides information on upcoming scheduled recordings.
 +
 
 +
<div class="myManualList">
 +
#Clicking the '<strong>View all</strong>' button will take the user to the schedule section. <br><em>(See image below)</em>
 +
#When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area. <br><em>(See image below)</em>
 +
#{{img - icon | file = Edit.png}} <b>[[#Edit a Schedule|Edit]]</b>: Open the information tab for the recording. <br><em>(See image below)</em>
 +
#{{img - icon | file = Delete.png}} <b>[[#Delete a Schedule|Delete]]</b>: Delete the recording. <br><em>(See image below)</em>
 +
</div>
 
}}
 
}}
{{Back to VALT 6 Main Menu}}
+
 
 +
{{img - resize | file = VALT 6.3 Manual-Home 08.png}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Edit a Schedule | content =
 +
#Hover over a schedule.
 +
#Click the {{img - icon | file = Edit.png}} <strong>Edit</strong> icon.
 +
#Make the appropriate edits.
 +
#Click save.
 +
}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Delete a Schedule | content =
 +
#Hover over a schedule.
 +
#Click the {{img - icon | file = Delete.png}} <strong>Delete</strong> icon.
 +
}}
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Reports | content =
 +
If enabled, this card allows you to view various metrics and system reports
 +
 
 +
{{hr - 2}}
 +
 
 +
<div class="myManualList">
 +
#Clicking the '<strong>View all</strong>' button will take the user to the reports section.
 +
#When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area.
 +
</div>
 +
{{img - resize | file = VALT 6.3 Manual-Home 09.png}}
 +
}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Open a Report | content =
 +
#Hover over a report.
 +
#Click on the report.
 +
}}
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Announcements | content =
 +
This view provides general announcements, if utilized by your organization.
 +
}}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Home 10.png}}
 +
 
 +
{{Top of Page}}
 
}}
 
}}

Latest revision as of 13:15, 24 February 2025

Introduction

Accessing the Homepage

After logging in to the VALT software, you will automatically be directed to the Homepage.

The Homepage provides multiple cards that summarize key aspects of the system and allow you to perform quick actions.

VALT 6.3 Manual-Home 00.png


Available Cards

By default, all cards are visible on the Homepage.

Depending on your group permissios in the software, your account may be restricted from one or more of these features.

icon Rooms
An overview of the rooms in your VALT system.
icon Recent Recordings
A list of the most recent recordings created.
icon Schedules
Information on upcoming scheduled recordings.
icon Reports
If enabled, this allows you to view various metrics and system reports.
icon Announcements
General announcements, if utilized by your organization.

⇧ Back to Top


Personal Customization

By default, all summaries are visible on the Homepage.

VALT 6.3 Manual-Home 01.png

If you wish to disable any of these views, click on the corresponding icon at the top of the page.
6 port io block.png

Try it out!


Disabled views will display the icon with a slash through it.

Enabled Disabled
Reports.png Reports Hidden.png

When all buttons are deselected, your Homepage will show as empty. (See image below)

VALT 6.3 Manual-Home 05.png

⇧ Back to Top


Rooms

This view provides an overview of the rooms in your VALT system. This view will allow you to:

  • See the list of rooms you have access to.
  • See any ongoing recordings.
  • Start / Stop / Pause any ongoing recordings.
  • Go to the live room.

  1. Clicking the 'View all' button will take the user to the observe section.
    (See image below)
  2. When you hover over this card, a scrollbar will appear if all items do not display in the area.
    (See image below)
  3. Hovering over a room will reveal associated control buttons. Pressing the 'REC' button will open the recording modal to start a recording.
    (See image below)

VALT 6.3 Manual-Home 06.png


🕮Did you know? You can start and stop recordings from the Homepage.
6 port io block.png

Try it out!

Start a Recording

  1. Hover over a room.
  2. Click the icon REC icon.
  3. Enter in the appropriate information for the recording.
  4. Click the REC button.

Stop a Recording

  1. Hover over a room that is currently recording.
  2. Press the icon Stop icon.

Pause a Recording

  1. Hover over a room that is currently recording.
  2. Press the icon Pause icon.

⇧ Back to Top


Recent Recordings

This view provides a list of the most recent recordings created.

  1. Clicking the 'View all' button will take the user to the observe section.
    (See image below)
  2. When you hover over this card, a scrollbar will appear if all items do not display in the area.
    (See image below)
  3. icon Edit: Open the information tab for the recording.
    (See image below)
  4. icon Download: Download the recording.
    (See image below)
  5. icon Delete: Delete the recording.
    (See image below)

VALT 6.3 Manual-Home 07.png


Edit a Recording

  1. Hover over a recording.
  2. Click the icon Edit icon.
  3. Make the appropriate edits.
  4. Click save.

Download a Recording

  1. Hover over a recording.
  2. Click the icon Download icon.
  3. Select where you would like to download the video.
    Most browsers will default to your local Downloads folder.

🕮Videos will be saved as an MP4.


Delete a Recording

  1. Hover over a recording.
  2. Click the icon Delete icon.

Deleting a video cannot be undone.

⇧ Back to Top


Schedules

This view provides information on upcoming scheduled recordings.

  1. Clicking the 'View all' button will take the user to the schedule section.
    (See image below)
  2. When you hover over this card, a scrollbar will appear if all items do not display in the area.
    (See image below)
  3. icon Edit: Open the information tab for the recording.
    (See image below)
  4. icon Delete: Delete the recording.
    (See image below)

VALT 6.3 Manual-Home 08.png


Edit a Schedule

  1. Hover over a schedule.
  2. Click the icon Edit icon.
  3. Make the appropriate edits.
  4. Click save.

Delete a Schedule

  1. Hover over a schedule.
  2. Click the icon Delete icon.

⇧ Back to Top


Reports

If enabled, this card allows you to view various metrics and system reports


  1. Clicking the 'View all' button will take the user to the reports section.
  2. When you hover over this card, a scrollbar will appear if all items do not display in the area.

VALT 6.3 Manual-Home 09.png


Open a Report

  1. Hover over a report.
  2. Click on the report.

⇧ Back to Top


Announcements

This view provides general announcements, if utilized by your organization.

VALT 6.3 Manual-Home 10.png

⇧ Back to Top