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

From IVS Wiki
Jump to: navigation, search
 
(33 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__TOC__
 
__TOC__
 
{{Section | width = 100% | title = <h2>Intro</h2> | content =  
 
{{Section | width = 100% | title = <h2>Intro</h2> | content =  
−
==Accessing the Homepage==
+
===Accessing the Homepage===
−
After logging into Vault software, you will automatically be directed to the <strong>Homepage</strong>. This page provides a broad summary of key aspects of the system.
+
After logging in to the VALT software, you will automatically be directed to the <strong>Homepage</strong>.  
 +
 
 +
The Homepage provides multiple cards that summarize key aspects of the system and allow you to perform quick actions.
  
 
{{hr}}
 
{{hr}}
  
 +
===Available Cards===
 +
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>
 
<dl>
−
<dt>[[#Rooms | Rooms:]]</dt>
+
<dt>[[#Rooms|Rooms]]</dt>
 
<dd>An overview of the rooms in your VALT system.</dd>
 
<dd>An overview of the rooms in your VALT system.</dd>
−
<dt>Recent Recordings:</dt>
+
<dt>[[#Recent Recordings|Recent Recordings]]</dt>
 
<dd>A list of the most recent recordings created.</dd>
 
<dd>A list of the most recent recordings created.</dd>
−
<dt>Schedules:</dt>
+
<dt>[[#Schedules|Schedules]]</dt>
 
<dd>Information on upcoming scheduled recordings.</dd>
 
<dd>Information on upcoming scheduled recordings.</dd>
−
<dt>Reports:</dt>
+
<dt>[[#Reports|Reports]]</dt>
−
<dd>If enabled, you can view various metrics and system reports.</dd>
+
<dd>If enabled, this allows you to view various metrics and system reports</dd>
−
<dt>Announcements:</dt>
+
<dt>[[#Announcements|Announcements]]</dt>
 
<dd>General announcements, if utilized by your organization.</dd>
 
<dd>General announcements, if utilized by your organization.</dd>
 
</dl>
 
</dl>
Line 21: Line 26:
 
{{img left | file = VALT 6.3 Manual-Home 00.png | width = 960px}}
 
{{img left | file = VALT 6.3 Manual-Home 00.png | width = 960px}}
  
−
{{Back to VALT 6 Main Menu}}
+
{{Top of Page}}
−
}}
+
 
 +
{{hr}}
  
−
{{Section | width = 100% | title = <h2>Personal Customization</h2> | content =
+
<h3>Personal Customization</h3>
 
By default, all summaries are visible on the Homepage.  
 
By default, all summaries are visible on the Homepage.  
−
 
−
{{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}} }}
 
−
 
−
<em>Disabled views will display the icon with a slash through it.</em>
 
−
 
−
<dl class="remove_img_margin singleLineHeight">
 
−
<dt>Enabled</dt>
 
−
<dd>{{img left | file = Reports.png | width = 30px}}</dd>
 
−
<dt>Disabled</dt>
 
−
<dd>{{img left | file = Reports Hidden.png | width = 30px}}</dd>
 
−
</dl>
 
  
 
{{img with key | width = 960px | file = VALT 6.3 Manual-Home 01.png | list =   
 
{{img with key | width = 960px | file = VALT 6.3 Manual-Home 01.png | list =   
Line 45: Line 40:
 
<li>Announcements</li>
 
<li>Announcements</li>
 
}}
 
}}
 +
 +
{{hr}}
 +
 +
{{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}} }}
 +
 +
<em>Disabled views will display the icon with a slash through it.</em>
 +
 +
<table style="border-spacing: 50px 5px; color:var(--ivsOrange)">
 +
<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}}
 
{{hr}}
Line 50: Line 62:
 
{{img left | file = VALT 6.3 Manual-Home 05.png | width = 960px}}
 
{{img left | file = VALT 6.3 Manual-Home 05.png | width = 960px}}
  
−
{{Back to VALT 6 Main Menu}}
+
{{Top of Page}}
 
}}
 
}}
  
Line 58: Line 70:
 
{{hr}}
 
{{hr}}
  
−
From here you can:
+
This view will allow you to:
 
*See the list of rooms you have access to.
 
*See the list of rooms you have access to.
 
*See any ongoing recordings.
 
*See any ongoing recordings.
−
*Start/stop/pause any ongoing recordings.
+
*<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.
 
*Go to the live room.
  
 
{{img with key | file = VALT 6.3 Manual-Home 06.png | list =   
 
{{img with key | file = VALT 6.3 Manual-Home 06.png | list =   
 
<li>Clicking the <b>View all</b> button will take the user to the observe section.</li>
 
<li>Clicking the <b>View all</b> button will take the user to the observe section.</li>
−
<li>When you hover over a section a <b>scrollbar</b> will appear if all rooms do not fit on the card.</li>
+
<li>When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area.</li>
−
<li>Hovering over a room will reveal associate control buttons.  Pressing the <b>REC</b> button will pull up the recording modal as shown above. <em>Clicking Record will start recording on the associated room as shown below.</em></li>
+
<li>Hovering over a room will reveal associated control buttons.  Pressing the <b>REC</b> button will open the recording modal as shown above. <em>Clicking Record will start a recording on the associated room, as shown below.</em></li>
 
}}
 
}}
  
 
{{hr}}
 
{{hr}}
−
{{Aside - Helpful | content = <b>Did you know?</b> You can [[#Starting a Recording | start]] and [[#Stop a Recording| stop]] recordings from the Homepage. {{Try it out | link = https://app.storylane.io/share/blbhcupd84qj}} }}
+
 
−
===Starting a Recording===
+
{{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}} }}
 +
===Start a Recording===
 
#Hover over a room.
 
#Hover over a room.
−
#Click the <b>REC</b> button.
+
#Click the {{img - icon | file = Record.png}} <b>REC</b> icon.
 
#Enter in the appropriate information for the recording.
 
#Enter in the appropriate information for the recording.
−
#Press {{Keyboard | key = Enter}}
+
#Click the REC button.
  
 
{{hr}}
 
{{hr}}
 +
 
===Stop a Recording===
 
===Stop a Recording===
 
#Hover over a room that is currently recording.
 
#Hover over a room that is currently recording.
−
#Press the <b>Stop Icon</b>.
+
#Press the {{img - icon | file = Stop.png}} <b>Stop</b> icon.
−
{{Back to VALT 6 Main Menu}}
+
 
 +
{{hr}}
 +
 
 +
===Pause a Recording===
 +
#Hover over a room that is currently recording.
 +
#Press the {{img - icon | file = Pause.png}} <b>Pause</b> icon.
 +
 
 +
{{Top of Page}}
 
}}
 
}}
  
−
{{Section | width = 100% | title = <h2>Navigation Menu</h2> | content =  
+
{{Section | width = 100% | title = <h2>Recent Recordings</h2> | content =  
−
{{Aside - Helpful | content = <b>Did you know?</b> Admins can remove entire sections of the software based on group.}}
+
This view provides a list of the most recent recordings created.
  
−
Navigate around the software using the icons on the lefthand bar in VALT.
+
{{img with key | file = VALT 6.3 Manual-Home 07.png | list = 
 +
<li>Clicking the <b>View all</b> button will take the user to the observe section.</li>
 +
<li>When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area.</li>
 +
<li><b>[[#Edit a Recording|Edit]]</b>: Open the information tab for the recording.</li>
 +
<li><b>[[#Download a Recording|Download]]</b>: Download the recording.</li>
 +
<li><b>[[#Delete a Recording|Delete]]</b>: Delete the recording. </li>
 +
{{Aside - Warning | hue = 0 | content = Deleting a video <b>cannot be undone</b>.}}
 +
}}
  
 
{{hr}}
 
{{hr}}
  
−
===Icon Meanings===
+
===Edit a Recording===
−
<div class="remove_img_margin">
+
#Hover over a recording.
−
<dl>
+
#Click the {{img - icon | file = Edit.png}} <b>Edit</b> icon.
−
<dt>Home</dt>
+
#Make the appropriate edits.
−
<dd></dd>
+
#Click save.
−
<dd>{{img left | file = VALT 6 Home Icon.png | width = 40px}}</dd>
+
{{hr}}
−
<dt>Observe</dt>
+
 
−
<dd>{{img left | file = VALT 6 Observe Icon.png | width = 40px}}</dd>
+
===Download a Recording===
−
<dt>Review</dt>
+
#Hover over a recording.
−
<dd>{{img left | file = VALT 6 Review Icon.png | width = 40px}}</dd>
+
#Click the {{img - icon | file = Download.png}} <b>Download</b> icon.
−
<dt>Schedule</dt>
+
#Select where you would like to download the video.
−
<dd>{{img left | file = VALT 6 Schedule Icon.png | width = 40px}}</dd>
+
#:<em>Most browsers will default to your local Downloads folder.</em>
−
</dl>
+
{{Aside - Helpful | content = Videos will be saved as an MP4.}}
−
</div>
+
{{hr}}
 +
 
 +
===Delete a Recording===
 +
#Hover over a recording.
 +
#Click the {{img - icon | file = Delete.png}} <b>Delete</b> icon.
 +
{{Aside - Warning | hue = 0 | content = Deleting a video <b>cannot be undone</b>.}}
 +
 
 +
{{hr}}
 +
 
 +
{{Top of Page}}
 +
}}
 +
 
 +
{{Section | width = 100% | title = <h2>Schedules</h2> | content =
 +
This view provides information on upcoming scheduled recordings.
 +
 
 +
{{img with key | file = VALT 6.3 Manual-Home 08.png | list =
 +
<li>Clicking the <b>View all</b> button will take the user to the schedule section.</li>
 +
<li>When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area.</li>
 +
<li><b>[[#Edit a Schedule|Edit]]</b>: Open the information tab for the recording.</li>
 +
<li><b>[[#Delete a Schedule|Delete]]</b>: Delete the recording.</li>
 +
}}
 +
 
 +
{{hr}}
 +
 
 +
===Edit a Schedule===
 +
#Hover over a schedule.
 +
#Click the {{img - icon | file = Edit.png}} <b>Edit</b> icon.
 +
#Make the appropriate edits.
 +
#Click save.
 +
{{hr}}
 +
 
 +
===Delete a Schedule===
 +
#Hover over a schedule.
 +
#Click the {{img - icon | file = Delete.png}} <b>Delete</b> icon.
  
−
{{Back to VALT 6 Main Menu}}
+
{{Top of Page}}
 
}}
 
}}
  
−
{{Section | width = 100% | title = <h2>User Settings and Notifications</h2> | content =  
+
{{Section | width = 100% | title = <h2>Reports</h2> | content =  
−
{{img with key | file = VALT 6.3 Manual-Home 04.png | list =   
+
If enabled, this card allows you to view various metrics and system reports
−
<li>Account notifications.</li>
+
 
−
<li>Account settings, VALT alerts, help section, and logout.</li>
+
{{img with key | file = VALT 6.3 Manual-Home 09.png | list =   
 +
<li>Clicking the <b>View all</b> button will take the user to the reports section.</li>
 +
<li>When you hover over this card, a <b>scrollbar</b> will appear if all items do not display in the area.</li>
 
}}
 
}}
−
{{Back to VALT 6 Main Menu}}
+
 
 +
{{hr}}
 +
 
 +
===Open a Report===
 +
#Hover over a report.
 +
#Click on the report.
 +
 
 +
{{Top of Page}}
 +
}}
 +
 
 +
{{Section | width = 100% | title = <h2>Announcements</h2> | content =
 +
This view provides general announcements, if utilized by your organization.
 +
 
 +
{{img left | file = VALT 6.3 Manual-Home 10.png | width = 960px}}
 +
 
 +
{{Top of Page}}
 
}}
 
}}

Latest revision as of 17:06, 8 January 2025

Intro

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.

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.

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

⇧ Back to Top

Personal Customization

By default, all summaries are visible on the Homepage.

VALT 6.3 Manual-Home 01.png

  1. Rooms
  2. Recent Recordings
  3. Schedules
  4. Reports
  5. Announcements
✎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.

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.

VALT 6.3 Manual-Home 06.png

  1. Clicking the View all button will take the user to the observe section.
  2. When you hover over this card, a scrollbar will appear if all items do not display in the area.
  3. Hovering over a room will reveal associated control buttons. Pressing the REC button will open the recording modal as shown above. Clicking Record will start a recording on the associated room, as shown below.
🕮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.

VALT 6.3 Manual-Home 07.png

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

    6. ⚠Deleting a video cannot be undone.

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.

VALT 6.3 Manual-Home 08.png

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

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

VALT 6.3 Manual-Home 09.png

  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.

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

Retrieved from "https://ipivs.info/wiki/index.php?title=Template:VALT_6_Manual_-_Home&oldid=13857"