Difference between revisions of "VALT Manual Schedule"

From IVS Wiki
Jump to: navigation, search
(→‎Schedule)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
=Schedule=
+
{{Article - Manual | content =  
−
<div class='floating_card'>This section is used to schedule future recordings. Schedules can automatically start / stop recordings on a single or recurring instance. </div>
+
 
−
 
+
<h1>Overview</h1>
−
{{img with key | file = Schedule1.jpg | list =
+
The Schedule section is used to automate future recordings. Schedules can automatically start and stop recordings on a single or recurring basis with the information that you enter in advance.
−
<li>Navigation Menu: the navigation menu may collapse, and only display icons when in the schedule section depending on browser width. To navigate to a different section click the associated icon.</li>
+
 
−
<li>New Schedule: clicking on this button will pull up the new schedule menu.</li>
+
{{img - resize | file = VALT 6.3 Manual-Schedule 00.png}}
−
<li>Exceptions: clicking this button will pull up the new exception menu, exceptions being days where all scheduled recordings are suspended (example: holidays).</li>
+
 
−
<li>Schedule Column Headers: clicking on a schedule header will sort the schedules by that item.</li>
+
{{hr}}
−
<li>Schedule Search Box: narrows the results of shown schedules based on any information associated with that schedule.</li>
+
 
−
<li>Filter: advanced search queries that are associated with a user account that can be saved and executed using this dropdown.</li>
+
<h1>Adding a New Schedule</h1>
−
<li>View Mode: switch between list and calendar view for schedules by clicking the associated icon.</li>
+
#Click the {{Add Button}} <strong>Add</strong> icon in the upper right corner.
−
<li>Export Button: export schedule list to pdf or cvs.</li>
+
#Select a room to record in.
 +
#Fill in the [[#Information|information]] for your session.
 +
#Fill out the schedule information under [[#Date and Time|Date and Time]].
 +
#Click <strong>Create</strong>
 +
 
 +
 
 +
While creating a schedule, you have the ability to modifying any of the follow:
 +
 
 +
#{{img - icon | file = Information.png | width = 14px}}  [[#Information|Information]]
 +
#{{img - icon | file = Sharing.png | width = 16px}} [[#Sharing|Sharing]]
 +
#{{img - icon | file = Author.png | width = 18px}} [[#Author|Author]]
 +
#{{img - icon | file = Delete.png}}  [[#Retention|Retention]]
 +
#{{img - icon | file = Control.png | width = 16px}} [[#Control|Control]]
 +
 
 +
 
 +
{{Aside - Helpful | hue =  260 | content =  Want to see <b>Adding a Schedule</b> in action? {{Try it out | link = https://app.storylane.io/share/5yrcew4cwujr}} }}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 2 | title = Information | content = The {{img - icon | file = Information.png | width = 14px}} <strong>Information</strong> section allows you to select the Room for the Schedule and add the [[VALT_User_Training_Guide_-_Templates#Information_Templates|Information Template]].}}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 01.png}}
 +
 
 +
{{Manual lvl 3 | title = Information Template | content = Fill out your information template with the appropriate information for the schedule.  
 +
{{Aside | content = The template will be applied to all recordings in the series.}}
 +
{{hr}}
 
}}
 
}}
  
−
{{img with key | file = Schedule2.jpg | list =  
+
{{Manual lvl 3 | title = Date and Time | content = Use this section to define the time(s) that the scheduled recording should run.
−
<li>Mult-Select: checking the checkbox to the left of a recording will select (highlight) the recording.  Checking the top checkbox will select all the recordings on the page.</li>
+
<center>{{img - no click | file = VALT 6.3 Manual-Schedule Date and Time.png}}</center>
−
<li>Options: clicking the options button will pull up a sub menu that will display the functions the user has access to perform on the selected schedule.</li>
 
−
<li>Edit: pulls up the schedule menu allowing the user to edit any of the schedule attributes.</li>
 
−
<li>Sharing: This allows a user to modify the sharing attributes related to the schedule and the recordings the schedule produces.</li>
 
−
<li>Change Author: pulls up the change author menu, the author applies to both the schedule and the recordings the schedule produces.</li>
 
−
<li>Retention: controls the period of time recordings produced by the schedule are stored for before being purged.</li>
 
−
<li>Control: allows users to select presets (for PTZ cameras only) that a camera will move to just prior to the start of the scheduled recording(s)</li>
 
−
<li>Delete Next Instance: deletes just the next instance of the schedule (if a schedule is set to run every Monday, clicking this button would delete next Mondays recording, and roll to the following Monday as the next scheduled start time).</li>
 
−
<li>Delete All: removes the schedule and deletes all future recordings (does not affect past recordings created by the schedule).</li>
 
 
}}
 
}}
  
−
{{img with key | file = Schedule3.jpg | list =  
+
{{Manual lvl 4 | title = Date | content = This field defines the date of the first instance of the Schedule.
−
<li>Multi-Select: allows users to make changes to multiple schedules at once, checking items will highlight and enable the '''Multi-Options''' button as shown above.</li>
+
{{hr}} }}
−
<li>Multi-Options: clicking this button will open up a sub menu of options depending on the user rights that can be applied to the selected schedules.</li>
+
 
−
<li>Option Menu: '''Sharing''', '''Retention''' and '''Delete''' are options that can be applied to the selected schedules. Note only the options the active user has access to will appear.</li>
+
{{Manual lvl 4 | title = Time | content = This field defines the time of day for the schedule.
 +
{{hr}} }}
 +
 
 +
{{Manual lvl 4 | title = Duration | content = This field defines how long the Scheduled recording runs.
 +
{{hr}} }}
 +
 
 +
{{Manual lvl 4 | title = Repeat | content = This option defines whether the Schedule run once or multiple times as part of a series of recordings occurring at the same time in the same room.
 +
 
 +
<center>{{img - no click | file = VALT 6.3 Manual-Schedule Date and Time Repeat.png}}</center>
 +
 
 +
<dl>
 +
<dt>Daily</dt>
 +
<dd>Selecting this option will cause the schedule to run <b>every day</b> at the specified time.</dd>
 +
{{hr - 2}}
 +
<dt>Weekly</dt>
 +
<dd>Selecting this option will cause the schedule to run each <b>week</b> on the same day of the week. You can select additional days of the week if the schedule should occur on multiple days of the week.</dd>
 +
{{hr - 2}}
 +
<dt>Monthly</dt>
 +
<dd>Selecting this option will cause the schedule to run each <b>month</b> on the specified date.</dd>
 +
<dd><em>(e.g. the 1st of every month)</em></dd>
 +
</dl>
 
}}
 
}}
  
−
==Calendar View==
 
−
<div class='floating_card'>The calendar view for the schedule section is a graphical way to look at upcoming schedules.  A user group's default view can be set to either list or calendar for the schedule section.</div>
 
  
−
{{img with key | file = Schedule4.jpg | list =  
+
{{Top of Page}}
−
<li>Date: this field is used to define what date is shown.</li>
+
{{hr}}
−
<li>New Schedule: clicking on this button will pull up the new schedule menu.</li>
+
 
−
<li>Exceptions: clicking this button will pull up the new exception menu, exceptions being days where all scheduled recordings are suspended (example: holidays).</li>
+
{{Manual lvl 2 | title = Sharing | content = The {{img - icon | file = Sharing.png | width = 16px}} <strong>Sharing</strong> section allows users to select additional users who can see the scheduled recordings.}}
−
<li>View Mode: switch between list and calendar view for schedules by clicking the associated icon.</li>
+
 
−
<li>Schedules: recordings are shown as blue bar, if there is a overlap or a conflict where two recordings are scheduled in the same room at the same time the bar will appear red.</li>
+
{{img - resize | file = VALT 6.3 Manual-Schedule 02.png}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Author | content = The {{img - icon | file = Author.png | width = 18px}} <strong>Author</strong> section allows users to change the author of the scheduled recordings.
 +
{{Aside | content = By default, the user creating the schedule will be set as the author.}} }}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 03.png}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Retention | content = The {{img - icon | file = Delete.png}} <strong>Retention</strong> sections allows users to change the retention policy for the recordings that are part of the schedule.
 +
 
 +
{{Aside | content = By default, it will use the retention policy of the author.}} }}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 04.png}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Control | content = The {{img - icon | file = Control.png | width = 16px}} <strong>Control</strong> section allows users to specify a [[VALT_Manual_Observe#Presets|preset]] location for the camera to move to at the start of the schedule, if you are utilizing [[VALT_Devices#PTZ_Cameras|PTZ cameras]].}}
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 05.png}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
<h1>Exceptions</h1>
 +
 
 +
Clicking the {{img - icon color | file = Exceptions.png | width = 14px}} <strong>Exceptions</strong> button will pull up the exception menu. Exceptions are days where all regularly scheduled recordings will not occur <em>(example: holidays)</em>.
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 06.png}}
 +
 
 +
{{Manual lvl 2 | title = View All | content = View all exceptions currently in place.  Clicking the X next to an exception will remove it from the list.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Add to Exceptions | content = Select a date, insert a name, and click this button to add the date to your exceptions list.
 +
 
 +
 
 +
{{Aside - Helpful | hue =  260 | content =  Want to see <b>Adding an Exception</b> in action? {{Try it out | link = https://app.storylane.io/share/mwxsgcjbe1dm}} }}
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
<h1>Navigation</h1>
 +
 
 +
{{Manual lvl 2 | title = Table View | content = View the scheduled recordings in a grid with the following columns:  
 +
 
 +
 
 +
<dl>
 +
<dt>Name</dt>
 +
<dd>This field shows the Title of the Schedule.</dd>
 +
<dt>Room</dt>
 +
<dd>This field shows what Room the Schedule will occur in.</dd>
 +
<dt>Author</dt>
 +
<dd>This field shows who is the Author of the scheduled Recordings.</dd>
 +
<dt>Starts</dt>
 +
<dd>This field shows when the Schedule will run next.</dd>
 +
<dt>Duration</dt>
 +
<dd>This field shows how long the Scheduled recording will run.</dd>
 +
<dt>Repeat</dt>
 +
<dd>This field shows what days the Schedule will occur, if it has multiple occurrences.</dd>
 +
</dl>  
 
}}
 
}}
  
−
==Add Schedule==
 
  
−
{{img with key | file = Schedule7.jpg | list =  
+
{{Manual lvl 3 | title = Sortable Column Headers | content = Clicking on any of the column titles will sort results alphabetically or chronologically on the selected column. Click again to invert the order.}}
−
<li>Clicking '''New Schedule''' will bring up the information menu as shown above.</li>
+
 
−
<li>Select a room for the schedule.</li>
+
{{img - resize | file = VALT 6.3 Manual-Schedule 07.png}}
−
<li>Fill in the information template.</li>
+
 
−
<li>Videos associated with the recording can be shared with users who normally would not have access using the '''Sharing''' section.</li>
+
{{hr - 2}}
−
<li>Retention of video files created by the schedule can be modified from the default using the '''Retention''' section.</li>
+
 
 +
{{Manual lvl 3 | title = Reading the Table View | content = Scheduled recordings will display in the following ways:}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Scheduled Recordings | content = Recordings that are scheduled with no overlap will show in <b>white</b>.}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Conflicting Schedules | content = Schedules that are scheduled to occur in the same space at the same time will appear in yellow or red with an alert icon on the right side. When two schedules overlap, the second one chronologically will only start once the first one has been stopped.
 +
 
 +
 
 +
{{Aside - Warning | hue = 0 | content = Schedules in <b>red</b> will have the error:
 +
 
 +
<center><em>"This recording will not start.<br>There is another recording planned at this time."</em></center>}}
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 08.png}}
 +
 
 +
{{hr}}
 +
 
 +
{{Aside - Warning | hue = 50 | content = Schedules in <b>yellow</b> will have the error:
 +
 
 +
<center><em>"This recording overlaps another one.<br>It will only start when the previous reocrding stops."</em></center>}}
 +
{{img - resize | file = VALT 6.3 Manual-Schedule 09.png}}
 
}}
 
}}
  
−
{{img with key | file = Schedule8.jpg | list =  
+
 
−
<li>Select a date for the schedule to start on.</li>
+
{{Manual lvl 4 | title = Exceptions | content = Any scheduled recordings on days that are marked as exceptions will display in <b>red</b> and be crossed out.}}
−
<li>Select a time for the schedule to start on.</li>
+
 
−
<li>The schedule can be repeated on specific days using the '''Recurrence''' option as shown above.</li>
+
 
−
<li>The schedule can automatically end on a specific day by selecting an option under range.</li>
+
{{Manual lvl 4 | title = In-Progress Schedules | content = If a scheduled recording is in progress, the <b>Starts</b> field will display a timer showing how long the recording has been running. Additionally, if you hover over the in-progress schedule you will see a few options.}}
 +
 
 +
 
 +
{{Manual lvl 5 | title = Stop Schedule | content = Select this option to end the schedule early. }}
 +
 
 +
 
 +
{{Manual lvl 5 | title = Schedule Time | content = Select this option to change the amount of time the schedule will run. Use the <b>+/-</b> toggle to define whether you will add or subtract time from the schedule. Click the +/- <b>x</b> min to add or subtract that amount of time. You may select an option multiple times for a stacking effect. The <b>Duration</b> field will update to reflect the additional time.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Edit a Schedule | content = Hover over a scheduled recording and click the pencil icon to modify the pre-defined Information, Sharing, Author, Retention, or Control settings.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Delete a Schedule | content = Hover over a scheduled recording and click the trash can icon to delete future occurrences of the schedule.}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Delete all instances | content = This option <b>permanently</b> deletes the remaining instances of the schedule.}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Delete next occurrence | content = This option will cause the system to skip <b>only the next instance</b> of the schedule, picking back up with the following scheduled occurrence.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Search | content = Search for any scheduled recording by typing in text from the Name, Room, or Author.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Pagination | content = In the bottom right corner, select how many schedules you want to appear per page. }}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Timeline View | content = View the scheduled recordings in a daily calendar format, sorted by Room and Time of Day. }}
 +
 
 +
 
 +
{{Manual lvl 3 | title = Add New Schedule | content = While in the Timeline View, click the plus button next to any room name on the left side to create a new schedule specifically for that room.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Date | content = Select the date you wish to view in the upper left corner.}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Reading the Timeline View | content = Scheduled recordings will display in the following ways:}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Scheduled Recordings | content = Recordings that are scheduled with no overlap will show in <strong>blue</strong>.
 +
 
 +
 
 +
Click on a recording to view the:
 +
*Name
 +
*Author
 +
*Start time
 +
*End times
 
}}
 
}}
  
−
{{img with key | file = Schedule9.jpg | list =  
+
 
−
<li>A user can move PTZ camera(s) associated with the schedule to a preset position using the '''Control''' section as shown above.</li>
+
{{Manual lvl 4 | title = Conflicting Schedules | content = Schedules that are scheduled to occur in the same space at the same time will appear in <strong>orange</strong>. When two schedules overlap, the second one chronologically will only start once the first one has been stopped.}}
 +
 
 +
 
 +
{{Manual lvl 4 | title = Exceptions | content = Any scheduled recordings on days that are marked as exceptions will display in <strong>red</strong> and be crossed out.}}
 +
 
 +
 
 +
{{Top of Page}}
 
}}
 
}}
 +
 +
[[Category:VALT]]
 +
[[Category:VALT 6.3]]

Latest revision as of 17:18, 13 March 2025

Overview

The Schedule section is used to automate future recordings. Schedules can automatically start and stop recordings on a single or recurring basis with the information that you enter in advance.

VALT 6.3 Manual-Schedule 00.png

Adding a New Schedule

  1. Click the + Add icon in the upper right corner.
  2. Select a room to record in.
  3. Fill in the information for your session.
  4. Fill out the schedule information under Date and Time.
  5. Click Create


While creating a schedule, you have the ability to modifying any of the follow:

  1. icon Information
  2. icon Sharing
  3. icon Author
  4. icon Retention
  5. icon Control


🕮Want to see Adding a Schedule in action?
6 port io block.png

Try it out!

Information

The icon Information section allows you to select the Room for the Schedule and add the Information Template.

VALT 6.3 Manual-Schedule 01.png

Information Template

Fill out your information template with the appropriate information for the schedule.

✎The template will be applied to all recordings in the series.

Date and Time

Use this section to define the time(s) that the scheduled recording should run.

VALT 6.3 Manual-Schedule Date and Time.png

Date

This field defines the date of the first instance of the Schedule.

Time

This field defines the time of day for the schedule.

Duration

This field defines how long the Scheduled recording runs.

Repeat

This option defines whether the Schedule run once or multiple times as part of a series of recordings occurring at the same time in the same room.

VALT 6.3 Manual-Schedule Date and Time Repeat.png
Daily
Selecting this option will cause the schedule to run every day at the specified time.

Weekly
Selecting this option will cause the schedule to run each week on the same day of the week. You can select additional days of the week if the schedule should occur on multiple days of the week.

Monthly
Selecting this option will cause the schedule to run each month on the specified date.
(e.g. the 1st of every month)


⇧ Back to Top

Sharing

The icon Sharing section allows users to select additional users who can see the scheduled recordings.

VALT 6.3 Manual-Schedule 02.png


⇧ Back to Top

Author

The icon Author section allows users to change the author of the scheduled recordings.

✎By default, the user creating the schedule will be set as the author.

VALT 6.3 Manual-Schedule 03.png


⇧ Back to Top

Retention

The icon Retention sections allows users to change the retention policy for the recordings that are part of the schedule.

✎By default, it will use the retention policy of the author.

VALT 6.3 Manual-Schedule 04.png


⇧ Back to Top

Control

The icon Control section allows users to specify a preset location for the camera to move to at the start of the schedule, if you are utilizing PTZ cameras.

VALT 6.3 Manual-Schedule 05.png


⇧ Back to Top

Exceptions

Clicking the icon Exceptions button will pull up the exception menu. Exceptions are days where all regularly scheduled recordings will not occur (example: holidays).

VALT 6.3 Manual-Schedule 06.png

View All

View all exceptions currently in place. Clicking the X next to an exception will remove it from the list.


⇧ Back to Top

Add to Exceptions

Select a date, insert a name, and click this button to add the date to your exceptions list.


🕮Want to see Adding an Exception in action?
6 port io block.png

Try it out!


⇧ Back to Top

Navigation

Table View

View the scheduled recordings in a grid with the following columns:


Name
This field shows the Title of the Schedule.
Room
This field shows what Room the Schedule will occur in.
Author
This field shows who is the Author of the scheduled Recordings.
Starts
This field shows when the Schedule will run next.
Duration
This field shows how long the Scheduled recording will run.
Repeat
This field shows what days the Schedule will occur, if it has multiple occurrences.


Sortable Column Headers

Clicking on any of the column titles will sort results alphabetically or chronologically on the selected column. Click again to invert the order.

VALT 6.3 Manual-Schedule 07.png

Reading the Table View

Scheduled recordings will display in the following ways:


Scheduled Recordings

Recordings that are scheduled with no overlap will show in white.


Conflicting Schedules

Schedules that are scheduled to occur in the same space at the same time will appear in yellow or red with an alert icon on the right side. When two schedules overlap, the second one chronologically will only start once the first one has been stopped.


⚠Schedules in red will have the error:

"This recording will not start.
There is another recording planned at this time."

VALT 6.3 Manual-Schedule 08.png

⚠Schedules in yellow will have the error:

"This recording overlaps another one.
It will only start when the previous reocrding stops."

VALT 6.3 Manual-Schedule 09.png


Exceptions

Any scheduled recordings on days that are marked as exceptions will display in red and be crossed out.


In-Progress Schedules

If a scheduled recording is in progress, the Starts field will display a timer showing how long the recording has been running. Additionally, if you hover over the in-progress schedule you will see a few options.


Stop Schedule

Select this option to end the schedule early.


Schedule Time

Select this option to change the amount of time the schedule will run. Use the +/- toggle to define whether you will add or subtract time from the schedule. Click the +/- x min to add or subtract that amount of time. You may select an option multiple times for a stacking effect. The Duration field will update to reflect the additional time.

Edit a Schedule

Hover over a scheduled recording and click the pencil icon to modify the pre-defined Information, Sharing, Author, Retention, or Control settings.

Delete a Schedule

Hover over a scheduled recording and click the trash can icon to delete future occurrences of the schedule.


Delete all instances

This option permanently deletes the remaining instances of the schedule.


Delete next occurrence

This option will cause the system to skip only the next instance of the schedule, picking back up with the following scheduled occurrence.

Search

Search for any scheduled recording by typing in text from the Name, Room, or Author.

Pagination

In the bottom right corner, select how many schedules you want to appear per page.


⇧ Back to Top

Timeline View

View the scheduled recordings in a daily calendar format, sorted by Room and Time of Day.


Add New Schedule

While in the Timeline View, click the plus button next to any room name on the left side to create a new schedule specifically for that room.

Date

Select the date you wish to view in the upper left corner.

Reading the Timeline View

Scheduled recordings will display in the following ways:


Scheduled Recordings

Recordings that are scheduled with no overlap will show in blue.


Click on a recording to view the:

  • Name
  • Author
  • Start time
  • End times


Conflicting Schedules

Schedules that are scheduled to occur in the same space at the same time will appear in orange. When two schedules overlap, the second one chronologically will only start once the first one has been stopped.


Exceptions

Any scheduled recordings on days that are marked as exceptions will display in red and be crossed out.


⇧ Back to Top
Retrieved from "https://ipivs.info/wiki/index.php?title=VALT_Manual_Schedule&oldid=14968"