Difference between revisions of "VALT Administrator Guide 5.5"

From IVS Wiki
Jump to: navigation, search
(AWS Transcription Setup)
(SSO Configuration)
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=General=
 
=General=
The general section under '''Admin''' provides a snapshot of the software along with some management links as shown below.
+
<div class='floating_card'>The general section under '''Admin''' provides a snapshot of the software along with some management links as shown below.</div>
 
[[File:gen-1.jpg|800px]]
 
  
#) Admin: if a user has administrative rights they will be able to click on the '''Admin''' section.
+
{{img with key | file = gen-1.jpg | list =
#) General Link: the default section that will load once a user clicks on admin is '''General''' assuming they have access to this '''Admin''' section.  The general system provides some basic application and system information.
+
<li>Admin: if a user has administrative rights they will be able to click on the '''Admin''' section.</li>
#) Software Information: this displays the software version, license type, number of licenses and a link to a database management tool (phpmyadmin).
+
<li>General Link: the default section that will load once a user clicks on admin is '''General''' assuming they have access to this '''Admin''' section.  The general system provides some basic application and system information.</li>
#) Global Settings: this allows a user to toggle settings that apply to all users. The date format and video streaming method for live observation.  
+
<li>Software Information: this displays the software version, license type, number of licenses and a link to a database management tool (phpmyadmin).</li>
#) Email Settings: these are the connection settings to be used for email alerts.
+
<li>Global Settings: this allows a user to toggle settings that apply to all users. The date format and video streaming method for live observation. </li>
#) Media Server(s): this displays all the media servers associated with the software instance, the amount of storage used / remaining on each, and a management link for the video engine on each media server.  Note if a media server is online it will have a '''green''' name, if it is offline the name will appear in '''red''' as shown above.
+
<li>Email Settings: these are the connection settings to be used for email alerts.</li>
#) Customization: this allows a user to customize the login page with alternative graphics and links.
+
<li>Media Server(s): this displays all the media servers associated with the software instance, the amount of storage used / remaining on each, and a management link for the video engine on each media server.  Note if a media server is online it will have a '''<font color="green">green</font>''' name, if it is offline the name will appear in '''<font color="red">red</font>''' as shown above.</li>
 +
<li>Customization: this allows a user to customize the login page with alternative graphics and links.</li>
 +
}}
  
 
=Templates=
 
=Templates=
 +
<div class="floating_card">
 
Templates within VALT are used to tie searchable & reportable information to videos. A template(s) is assigned to a user group, where when that user starts or schedules a recording their set of templates will automatically get assigned to the associated recording(s). There are three types of templates listed below (Information, Marker, Evaluation).  Each template type has a set of fields that can be used in the creation of the template. A template can consist of any number of fields and field types. These templates can be created and customized to meet a wide range of unique applications and workflows.
 
Templates within VALT are used to tie searchable & reportable information to videos. A template(s) is assigned to a user group, where when that user starts or schedules a recording their set of templates will automatically get assigned to the associated recording(s). There are three types of templates listed below (Information, Marker, Evaluation).  Each template type has a set of fields that can be used in the creation of the template. A template can consist of any number of fields and field types. These templates can be created and customized to meet a wide range of unique applications and workflows.
 +
</div>
  
 
==Information Templates==
 
==Information Templates==
Information forms are typically used at the start of a recording to define information about that recording. Information templates can also be modified in the review section after a recording has been completed.
+
<div class='floating_card'>Information forms are typically used at the start of a recording to define information about that recording. Information templates can also be modified in the review section after a recording has been completed.</div>
  
 
===Information Field Types===
 
===Information Field Types===
When creating or modifying an information template there are a variety of field types that can be used. See below for reference.  
+
<div class='floating_card'>When creating or modifying an information template there are a variety of field types that can be used. See below for reference. </div>
  
1.) '''Text:''' This field is a freeform text box with a title. This field is limited to 128 characters.  
+
{{img with key | file = information-field.jpg | list =
 
+
<li>'''Text:''' This field is a freeform text box with a title. This field is limited to 128 characters. </li>
2.) '''Files:''' This field adds a button to the template that allows users to upload any number of .pdf, docx, and xlsx files. These files generate links within the template that can be used to download the uploaded files.
+
<li>'''Files:''' This field adds a button to the template that allows users to upload any number of .pdf, docx, and xlsx files. These files generate links within the template that can be used to download the uploaded files.</li>
 
+
<li>'''Quick Record:''' This field creates a titled clickable button on the information form.  If a user clicks this button it titles the recording with the button name and bypasses // ignores all other fields.</li>
3.) '''Quick Record:''' This field creates a titled clickable button on the information form.  If a user clicks this button it titles the recording with the button name and bypasses // ignores all other fields.
+
<li>'''Drop Down:''' This field is a drop down list with a title.  Any number of drop down options can be defined, but only a single one can be selected when a user is filling out the template.</li>
 
+
<li>'''Multi-Select:''' This field is a searchable drop down list with a title.  Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.</li>
4.) '''Drop Down:''' This field is a drop down list with a title.  Any number of drop down options can be defined, but only a single one can be selected when a user is filling out the template.
+
<li>'''Audio:''' This field is freeform text box with a title that includes icons for recording an audio note.  If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.</li>
 
+
<li>'''Note:''' This field is a larger freeform text box with a title. This field is limited to 500 characters.</li>
5.) '''Multi-Select:''' This field is a searchable drop down list with a title.  Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.
+
}}
 
 
6.) '''Audio:''' This field is freeform text box with a title that includes icons for recording an audio note.  If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.
 
 
 
7.) '''Note:''' This field is a larger freeform text box with a title. This field is limited to 500 characters.
 
 
 
[[File:information-field.jpg|800px]]
 
  
 
===Creating a New Information Template===
 
===Creating a New Information Template===
  
[[File:template_new.jpg|800px]]
+
{{img with key | file = template_new.jpg | list =
 
+
<li>Click the '''Admin''' button on the main navigation menu.</li>
#) Click the '''Admin''' button on the main navigation menu.
+
<li>Select '''Templates'''.</li>
#) Select '''Templates'''.
+
<li>Press '''Add Template'''.</li>
#) Press '''Add Template'''.
+
<li>Enter a template name.</li>
#) Enter a template name.
+
<li>Select the template type (Information).</li>
#) Select the template type (Information).
+
<li>Select the container.</li>
#) Select the container.
+
}}
 
 
[[File:template_new2.jpg|920px]]
 
  
#) The '''Add Field''' button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.
+
{{img with key | file = template_new2.jpg | list =
#) To enable a field within a template, the '''On''' checkbox must be checked.
+
<li>The '''Add Field''' button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.</li>
#) This dialog box is used to title the field.
+
<li>To enable a field within a template, the '''On''' checkbox must be checked.</li>
#) If the '''Req''' box is checked for the field it forces the user to input data into that field.
+
<li>This dialog box is used to title the field.</li>
#) This drop down box defines the field type.
+
<li>If the '''Req''' box is checked for the field it forces the user to input data into that field.</li>
#) This dialog box can be set to pre-populate the template form with data for that field.
+
<li>This drop down box defines the field type.</li>
#) This '''Edit''' button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the '''Notes''' text box field on the Information template form.  
+
<li>This dialog box can be set to pre-populate the template form with data for that field.</li>
#) This button deactivates the template so it is not shown and cannot be applied to user groups.
+
<li>This '''Edit''' button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the '''Notes''' text box field on the Information template form. </li>
#) This button saves the template.
+
<li>This button deactivates the template so it is not shown and cannot be applied to user groups.</li>
#) This button deletes the template, this button will only appear if there are no user groups using this template and if no recordings or schedules have been created using this template. If any of those conditions are true the only option to remove the template would be to deactivate (hide) the template.
+
<li>This button saves the template.</li>
 +
<li>This button deletes the template, this button will only appear if there are no user groups using this template and if no recordings or schedules have been created using this template. If any of those conditions are true the only option to remove the template would be to deactivate (hide) the template.</li>
 +
}}
  
 
==Marker Templates==
 
==Marker Templates==
Markers are used to tie information to specific points in a recording. Markers can be added during a recording or after the fact when reviewing a video recording. Markers create key point within the video that allow users to easily jump right to that point within a longer video (much like chapters in a DVD). The data associated with a marker can be overlayed as text on the video during playback.
+
<div class='floating_card'>Markers are used to tie information to specific points in a recording. Markers can be added during a recording or after the fact when reviewing a video recording. Markers create key point within the video that allow users to easily jump right to that point within a longer video (much like chapters in a DVD). The data associated with a marker can be overlaid as text on the video during playback.</div>
  
 
===Marker Field Types===
 
===Marker Field Types===
  
1.) '''Text:''' This field is a freeform text box with a title. This field is limited to 128 characters.  
+
{{img with key | file = marker-field.jpg | list =
 
+
<li>'''Text:''' This field is a freeform text box with a title. This field is limited to 128 characters. </li>
2.) '''Drop Down:''' This field is a dropdown list with a title.  Any number of drop down options can be defined but only a single one can be selected when a user is filling out the marker form.
+
<li>'''Drop Down:''' This field is a dropdown list with a title.  Any number of drop down options can be defined but only a single one can be selected when a user is filling out the marker form.</li>
 +
<li>'''Audio:''' This field is freeform text box with a title that includes icons for recording an audio note.  If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.</li>
 +
<li>'''Multi-Select:''' This field is a searchable drop down list with a title.  Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.</li>
 +
<li>'''Note:''' This field is a larger freeform text box with a title. This field is limited to 500 characters.</li>
 +
<li>'''Quick Mark:''' This field creates a titled clickable button on the marker form.  If a user clicks this button, it inserts a marker and titles the marker with the button this action bypasses // ignores all other fields.</li>
 +
}}
  
3.) '''Audio:''' This field is freeform text box with a title that includes icons for recording an audio note.  If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.
+
{{img with key | file = continous-field.jpg | start = 7 | list =
 
+
<li> '''Continous Marker:''' This field is only available as the first field within the marker template. Changing to this changes the formatting of the marker.  When the mark button is pressed it brings up the form as shown below and changes the behavior. To insert a marker a user can now simply type and press enter.  The marker is always inserted when they begin to type. This method is generally used when the workflow requires that many markers are being inserted.</li>
4.) '''Multi-Select:''' This field is a searchable drop down list with a title.  Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.
+
}}
 
 
5.) '''Note:''' This field is a larger freeform text box with a title. This field is limited to 500 characters.
 
 
 
6.) '''Quick Mark:''' This field creates a titled clickable button on the marker form.  If a user clicks this button, it inserts a marker and titles the marker with the button this action bypasses // ignores all other fields.
 
 
 
[[File:marker-field.jpg|800px]]
 
 
 
7.) '''Continous Marker:''' This field is only available as the first field within the marker template. Changing to this changes the formatting of the marker.  When the mark button is pressed it brings up the form as shown below and changes the behavior. To insert a marker a user can now simply type and press enter.  The marker is always inserted when they begin to type. This method is generally used when the workflow requires that many markers are being inserted.
 
 
 
[[File:continous-field.jpg|800px]]
 
  
 
===Creating a New Marker Template===
 
===Creating a New Marker Template===
  
[[File:marker-template.jpg|800px]]
+
{{img with key | file = marker-template.jpg | list =
 +
<li>Click the '''Admin''' button on the main navigation menu.</li>
 +
<li>Select '''Templates'''.</li>
 +
<li>Press '''Add Template'''. </li>
 +
<li>Enter a template name.</li>
 +
<li>Select the template type ('''Information''').</li>
 +
<li>Select the container.</li>
 +
}}
  
#) Click the '''Admin''' button on the main navigation menu.
+
{{img with key | file = marker-template1.jpg | list =
#) Select '''Templates'''.
+
<li>The '''Add Field''' button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.</li>
#) Press '''Add Template'''.  
+
<li>To enable a field within a template form the '''On''' checkbox must be checked.</li>
#) Enter a template name.
+
<li>This dialog box is used to title the field.</li>
#) Select the template type ('''Information''').
+
<li>If the '''Req''' box is checked for the field it forces the user to input data into that field.</li>
#) Select the container.
+
<li>This drop down box defines the field type.</li>
 +
<li>This dialog box can be set to pre-populate the template form with data for that field.</li>
 +
<li>This button is used to define the marker color that shows up on the timeline when a marker is inserted.</li>
 +
<li>This '''Edit''' button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the notes text box field on the information template form. </li>
 +
<li>This button deactivates the template so it is not shown and cannot be applied to user groups.</li>
 +
<li>This button saves the template.</li>
 +
<li>This button deletes the template and will only appear if there are no user groups using this template, and if no recordings or schedules have been created using this template. If any of those conditions are true, the only option to remove the template would be to deactivate (hide) the template.</li>
 +
}}
  
[[File:marker-template1.jpg|990px]]
+
==Evaluation Templates==
 +
<div class='floating_card'>Evaluation templates are typically used during a recording, or after a recording is completed. An evaluation form acts much like an information form in that it is used to tie a single set of information into the recording. The big difference between an evaluation and information form is that numeric values can be assigned to the fields within an evaluation form.  This allows scoring to be done on each item and the overall form. Evaluation also allow unique reports to be run against them that are based on score %.</div>
  
#) The '''Add Field''' button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.
 
#) To enable a field within a template form the '''On''' checkbox must be checked.
 
#) This dialog box is used to title the field.
 
#) If the '''Req''' box is checked for the field it forces the user to input data into that field.
 
#) This drop down box defines the field type.
 
#) This dialog box can be set to pre-populate the template form with data for that field.
 
#) This button is used to define the marker color that shows up on the timeline when a marker is inserted.
 
#) This '''Edit''' button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the notes text box field on the information template form.
 
#) This button deactivates the template so it is not shown and cannot be applied to user groups.
 
#) This button saves the template.
 
#) This button deletes the template and will only appear if there are no user groups using this template, and if no recordings or schedules have been created using this template. If any of those conditions are true, the only option to remove the template would be to deactivate (hide) the template.
 
 
==Evaluation Templates==
 
Evaluation templates are typically used during a recording, or after a recording is completed. An evaluation form acts much like an information form in that it is used to tie a single set of information into the recording. The big difference between an evaluation and information form is that numeric values can be assigned to the fields within an evaluation form.  This allows scoring to be done on each item and the overall form. Evaluation also allow unique reports to be run against them that are based on score %.
 
  
 
===Evaluation Template Fields===
 
===Evaluation Template Fields===
When creating or modifying an evaluation template, there are a variety of field types that can be used. See below for reference.
+
<div class='floating_card'>When creating or modifying an evaluation template, there are a variety of field types that can be used. See below for reference.</div>
  
1.'''Description:''' This field is a larger freeform text box with a question. This field is limited to 500 characters and allows the numerical value or score to be entered in the box below.
+
{{img with key | file = eval-field.jpg | list =
 +
<li> '''Description:''' This field is a larger freeform text box with a question. This field is limited to 500 characters and allows the numerical value or score to be entered in the box below.</li>
 +
<li>'''Single select:''' This field consists of radio button(s) each with a description and associated score. This field type allows a user to select a single option as shown below.</li>
 +
<li>'''Multi Checkbox:''' This field consists of checkboxes each with a description and associated score. This field type allows a user to select multiple boxes as shown below.</li>
 +
}}
  
2.) '''Single select:''' This field consists of radio button(s) each with a description and associated score. This field type allows a user to select a single option as shown below.
+
===Creating a New Evaluation Template===
  
3.) '''Multi Checkbox:''' This field consists of checkboxes each with a description and associated score. This field type allows a user to select multiple boxes as shown below.
+
{{img with key | file = eval-1.jpg | list =
 +
<li>Select Evaluation as the template type</li>
 +
<li>Add and name fields appropriately</li>
 +
<li>Select the field type, options include: Single Select, Multi Checkbox and Description.</li>
 +
<li>Edit button allows the user to enter the value along with options.</li>
 +
<li>Delete button deletes the field.</li>
 +
}}
  
[[File:eval-field.jpg|800px]]
+
{{img with key | file = eval-2.jpg | list =
 
+
<li>Add Option: this button adds additional options to the field.</li>
===Creating a New Evaluation Template===
+
<li>Allow Markers: this checkbox allows users to plot and call markers from this field within the evaluation form.</li>
[[File:eval-1.jpg|800px]]
+
<li>This dialog box defines the total maximum point value for the field.</li>
#) Select Evaluation as the template type
+
<li>This dialog box is used to name the option.</li>
#) Add and name fields appropriately
+
<li>This dialog box defines the point value for the associated option.</li>
#) Select the field type, options include: Single Select, Multi Checkbox and Description.
+
<li>Press Save to save the field, note once the template is complete the user will also press save at the template level.</li>
#) Edit button allows the user to enter the value along with options.
+
}}
#) Delete button deletes the field.
 
[[File:eval-2.jpg|800px]]
 
#) Add Option: this button adds additional options to the field.
 
#) Allow Markers: this checkbox allows users to plot and call markers from this field within the evaluation form.
 
#) This dialog box defines the total maximum point value for the field.
 
#) This dialog box is used to name the option.
 
#) This dialog box defines the point value for the associated option.
 
#) Press Save to save the field, note once the template is complete the user will also press save at the template level.
 
  
 
==Assigning a Template==
 
==Assigning a Template==
 +
<div class='floating_card'>Templates are always assigned to user groups, with the individual users then being added to the user groups</div>
  
Templates are always assigned to user groups, with the individual users then being added to the user groups.
+
{{img with key | file = assign_template.jpg | list =
 +
<li>Click the '''Admin''' button on the main navigation menu.</li>
 +
<li>Select '''Users & Groups'''.</li>
 +
<li>Click on the user group.</li>
 +
<li>Select a default marker template using the drop down menu, and additional marker templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.</li>
 +
<li>Select a default information template using the drop down menu, and additional information templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.</li>
 +
<li>Select a default evaluation template using the drop down menu, and additional evaluation templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recorded video.</li>
 +
}}
  
[[File:assign_template.jpg|800px]]
 
 
#) Click the '''Admin''' button on the main navigation menu.
 
#) Select '''Users & Groups'''.
 
#) Click on the user group.
 
#) Select a default marker template using the drop down menu, and additional marker templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.
 
#) Select a default information template using the drop down menu, and additional information templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.
 
#) Select a default evaluation template using the drop down menu, and additional evaluation templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recorded video.
 
  
 
=Rooms=
 
=Rooms=
Rooms act as containers for a camera or group of cameras.  Rooms can be recorded using a contact closure / card reader, schedule, or on demand through the user interface.  Rooms are also assignable from a user permission perspective.
+
<div class='floating_card'>Rooms act as containers for a camera or group of cameras.  Rooms can be recorded using a contact closure / card reader, schedule, or on demand through the user interface.  Rooms are also assignable from a user permission perspective.</div>
 
 
[[File:roo1.jpg]]
 
 
 
#) Clicking on the '''Rooms''' link under '''Admin''' will take you to the section displayed above.
 
#) Clicking on a room name will allow a user to edit the room name / settings.
 
#) Expanding a room will reveal the camera(s) associated with a room, while clicking on a camera will allow a user to edit the camera name / settings.
 
  
Clicking on a room name or clicking '''Add Room''' will pull up the room settings as shown below.
+
{{img with key | file = roo1.jpg | list =
 +
<li>Clicking on the '''Rooms''' link under '''Admin''' will take you to the section displayed above.</li>
 +
<li>Clicking on a room name will allow a user to edit the room name / settings.</li>
 +
<li>Expanding a room will reveal the camera(s) associated with a room, while clicking on a camera will allow a user to edit the camera name / settings.</li>
 +
}}
  
[[File:roo2.jpg]]
+
<div class='floating_card'>Clicking on a room name or clicking '''Add Room''' will pull up the room settings as shown below.</div>
  
#) Room Name: a room name can be entered here. This name will be the identifier that will be used throughout the rest of the system.
+
{{img with key | file = roo2.jpg | list =
#) Container: this specifies the container the template will use. Users are only able to see objects that are in the same container or a sub container.
+
<li>Room Name: a room name can be entered here. This name will be the identifier that will be used throughout the rest of the system.</li>
#) Cameras: this is used to associate cameras to a room.
+
<li>Container: this specifies the container the template will use. Users are only able to see objects that are in the same container or a sub container.</li>
#) View Type: this can be used to define a view type default for the room, if no option is selected the system will automatically use the assumed best fit view type for the number of cameras.
+
<li>Cameras: this is used to associate cameras to a room.</li>
#) Use I/O: this checkbox should be checked if you are using a push button to start / stop recordings.  When this is checked a sub menu with options will appear.
+
<li>View Type: this can be used to define a view type default for the room, if no option is selected the system will automatically use the assumed best fit view type for the number of cameras.</li>
#) Save / Delete: Once a room is configured pressing '''Save''' will save the changes.
+
<li>Use I/O: this checkbox should be checked if you are using a push button to start / stop recordings.  When this is checked a sub menu with options will appear.</li>
 +
<li>Save / Delete: Once a room is configured pressing '''Save''' will save the changes.</li>
 +
}}
  
Clicking on a camera name or clicking '''Add Camera''' will pull up the camera settings shown below.
+
<div class='floating_card'>Clicking on a camera name or clicking '''Add Camera''' will pull up the camera settings shown below.</div>
  
[[File:roo3.jpg]]
+
{{img with key | file = roo3.jpg | list =
 +
<li>Add Camera: to add a new camera click the '''Add Camera''' button, if the system has available device licenses available a menu will pop up as shown above.  </li>
 +
<li>Camera Name: this is a label that can be assigned to the camera, this name will be used throughout the rest of the system.</li>
 +
<li>IP: the DNS name or IP address of the camera should be entered here.</li>
 +
<li>HTTP Port: this is the port that will be used to authenticate to the camera (note: the default should be 80 unless changed within the camera).</li>
 +
<li>RTSP Port: this is the port that will be used to stream video between the camera and server (note: the default should be 554 unless changed within the camera).</li>
 +
<li>Username / Password: enter a admin username and password for the camera.</li>
 +
<li>Rooms: this can be used to assign the camera to room(s).</li>
 +
<li>Camera Control Color: the control color can be changed using this color picker.  Controls are overlaid on top of the video when enabled and include digital zoom and PTZ.</li>
 +
<li>Media Server: this option is used to define what server the camera is connected to.</li>
 +
<li>Brand: this drop down specifies what camera type is being used.</li>
 +
<li>Model: this drop down specifies what model camera is being used.</li>
 +
<li>Save: once the camera settings are set pressing '''Save''' will commit the settings / changes.</li>
 +
}}
  
#) Add Camera: to add a new camera click the '''Add Camera''' button, if the system has available device licenses available a menu will pop up as shown above. 
+
<div class='floating_card'>Clicking on a camera name or clicking '''Add Device''' will pull up the device settings shown below.</div>
#) Camera Name: this is a label that can be assigned to the camera, this name will be used throughout the rest of the system.
 
#) IP: the DNS name or IP address of the camera should be entered here.
 
#) HTTP Port: this is the port that will be used to authenticate to the camera (note: the default should be 80 unless changed within the camera).
 
#) RTSP Port: this is the port that will be used to stream video between the camera and server (note: the default should be 554 unless changed within the camera).
 
#) Username / Password: enter a admin username and password for the camera.
 
#) Rooms: this can be used to assign the camera to room(s).
 
#) Camera Control Color: the control color can be changed using this color picker.  Controls are overlaid on top of the video when enabled and include digital zoom and PTZ.
 
#) Media Server: this option is used to define what server the camera is connected to.
 
#) Brand: this drop down specifies what camera type is being used.
 
#) Model: this drop down specifies what model camera is being used.
 
#) Save: once the camera settings are set pressing '''Save''' will commit the settings / changes.
 
  
Clicking on a camera name or clicking '''Add Device''' will pull up the device settings shown below.
+
{{img with key | file = roo4.jpg | list =
 
+
<li>Add Device: to add a new device click the '''Add Device''' button, if the system has available device licenses available a menu will pop up as shown above.  </li>
[[File:roo4.jpg]]
+
<li>Device UID: if an iPhone / iPad is being added the device UID will need to be entered on the client side.</li>
 
+
<li>Rooms: this is used to add the device to room(s).</li>
#) Add Device: to add a new device click the '''Add Device''' button, if the system has available device licenses available a menu will pop up as shown above.   
+
<li>Device Name: this is a label that can be assigned to the device. This name will be used throughout the rest of the system.</li>
#) Device UID: if an iPhone / iPad is being added the device UID will need to be entered on the client side as documented here: http://ipivs.com/wiki/Installing_Mobile_Devices
+
<li>Device Type: this is used to define the type of device.</li>
#) Rooms: this is used to add the device to room(s).
+
<li>Save / Delete: make sure to click '''Save''' after settings are changed to commit the changes.</li>
#) Device Name: this is a label that can be assigned to the device. This name will be used throughout the rest of the system.
+
}}
#) Device Type: this is used to define the type of device.
 
#) Save / Delete: make sure to click '''Save''' after settings are changed to commit the changes.
 
  
 
=Containers=
 
=Containers=
Containers are used to segment objects. A user is only able to see objects (rooms, templates, user groups) in their container or a sub container.  Containers are typically implemented when multiple departments with administrator(s) of each department are sharing a single software instance.
+
<div class='floating_card'>Containers are used to segment objects. A user is only able to see objects (rooms, templates, user groups) in their container or a sub container.  Containers are typically implemented when multiple departments with administrator(s) of each department are sharing a single software instance.</div>
  
[[File:cont1.jpg]]
+
{{img with key | file = cont1.jpg | list =
 
+
<li>Clicking on the '''Containers''' link under '''Admin''' will take you to the section displayed above.</li>
#) Clicking on the '''Containers''' link under '''Admin''' will take you to the section displayed above.
+
<li>Add Container: clicking on '''Add Container''' brings up the menu shown on the right above.</li>
#) Add Container: clicking on '''Add Container''' brings up the menu shown on the right above.
+
<li>Container Name: this is the container identifier for the container throughout the rest of the system.</li>
#) Container Name: this is the container identifier for the container throughout the rest of the system.
+
<li>Parent Container: users have access to sub containers but not parent containers.  To place a container under another use the '''Parent Container''' drop down menu. </li>
#) Parent Container: users have access to sub containers but not parent containers.  To place a container under another use the '''Parent Container''' drop down menu.  
+
<li>Save / Delete: Once a container is configured click '''Save''' to commit the changes.</li>
#) Save / Delete: Once a container is configured click '''Save''' to commit the changes.
+
}}
  
 
=Media Server=
 
=Media Server=
Media servers are used to stream video / connect to cameras and store video.   
+
<div class='floating_card'>Media servers are used to stream video / connect to cameras and store video.  </div>
 
 
[[File:meds1.jpg]]
 
  
#) Clicking on the Media Server link under '''Admin''' will take you to the section displayed above.
+
{{img with key | file = meds1.jpg | list =
#) Add Media Server: clicking on '''Add Container''' brings up the menu shown on the right above.
+
<li>Clicking on the Media Server link under '''Admin''' will take you to the section displayed above.</li>
#) This lists all the existing media servers configured for the software instance.
+
<li>Add Media Server: clicking on '''Add Container''' brings up the menu shown on the right above.</li>
#) Media Server Name: this is an identifier used throughout the system.
+
<li>This lists all the existing media servers configured for the software instance.</li>
#) Address: the IP address or DNS name of the server.
+
<li>Media Server Name: this is an identifier used throughout the system.</li>
#) SSL Port: if encrypted video is desired this designates the default port used (note: 444 is the default unless otherwise specified within configuration files and server firewall).
+
<li>Address: the IP address or DNS name of the server.</li>
#) SSL: this checkbox enables video encryption.
+
<li>SSL Port: if encrypted video is desired this designates the default port used (note: 444 is the default unless otherwise specified within configuration files and server firewall).</li>
#) Storage Folder: this designates the folder name that the video will be stored in (note: default is valt_recordings unless otherwise specified).
+
<li>SSL: this checkbox enables video encryption.</li>
#) Save function
+
<li>Storage Folder: this designates the folder name that the video will be stored in (note: default is valt_recordings unless otherwise specified).</li>
 +
<li>Save function</li>
 +
}}
  
 
=Transcription=
 
=Transcription=
Prior to setting up transcription you will need an Amazon AWS account, an S3 storage bucket and a Access ID & Secret Key for API access.
+
<div class='floating_card'>Prior to setting up transcription you will need an Amazon AWS account, an S3 storage bucket and a Access ID & Secret Key for API access.</div>
  
 
==AWS Transcription Setup==
 
==AWS Transcription Setup==
 
[[File:transcribe_1.png|400px]]
 
[[File:transcribe_1.png|400px]]
  
#) Log into AWS with a root level account
+
<div class="section">
#) Click on the "S3" Storage service
+
* Log into AWS with a root level account
 +
* Click on the "S3" Storage service
 +
</div>
  
 
[[File:transcribe_2.png|800px]]
 
[[File:transcribe_2.png|800px]]
  
#) Press the "Create New Bucket" button
+
<div class="section">
 +
* Press the "Create New Bucket" button
 +
</div>
  
 
[[File:transcribe_3.png|800px]]
 
[[File:transcribe_3.png|800px]]
  
#) Give the bucket a name
+
<div class="section">
#) Click the "Save" button
+
* Give the bucket a name
 +
* Click the "Save" button
 +
</div>
  
 
[[File:transcribe_4.png|800px]]
 
[[File:transcribe_4.png|800px]]
  
#) Click on the account name then select "My Security Credentials"
+
<div class="section">
 +
* Click on the account name then select "My Security Credentials"
 +
</div>
  
 
[[File:transcribe_5.png|800px]]
 
[[File:transcribe_5.png|800px]]
  
#) Click on the "Create New Access Key" button
+
<div class="section">
 +
* Click on the "Create New Access Key" button
 +
</div>
  
 
[[File:transcribe_6.png|400px]]
 
[[File:transcribe_6.png|400px]]
  
#) Download and save the Key file (you will need this to configure VALT later)
+
<div class="section">
 +
* Download and save the Key file (you will need this to configure VALT later)
 +
</div>
  
 
==VALT Transcription Setup==
 
==VALT Transcription Setup==
  
[[File:transcribe_7.png|800px]]
+
{{img with key | file = transcribe_7.png | list =
 
+
<li>Click on the "Admin" section then select "Transcription"</li>
#) Click on the "Admin" section then select "Transcription"
+
<li>Click on "Add Transcription Service"</li>
#) Click on "Add Transcription Service"
+
<li>Enter a name (this is just a unique identifier used by VALT)</li>
#) Enter a name (this is just a unique identifier used by VALT)
+
<li>Enter the Access Key ID gathered from AWS</li>
#) Enter the Access Key ID gathered from AWS
+
<li>Enter the Secret Key that matches the Access Key from AWS</li>
#) Enter the Secret Key that matches the Access Key from AWS
+
<li>Select the Region that the AWS bucket is set within</li>
#) Select the Region that the AWS bucket is set within
+
<li>Click "Save"</li>
#) Click "Save"
+
}}
  
[[File:transcribe_8.png|800px]]
+
{{img with key | file = transcribe_8.png | list =
 
+
<li>Click on the "Admin" section then select "Media Servers"</li>
#) Click on the "Admin" section then select "Media Servers"
+
<li>Click on a media server you want to associate with the newly created transcription service</li>
#) Click on a media server you want to associate with the newly created transcription service
+
<li>Click on the "Transcription Service" drop down and select the name of the transcription service</li>
#) Click on the "Transcription Service" drop down and select the name of the transcription service
+
<li>Click "Save"</li>
#) Click "Save"
+
}}
  
 
=Users & Groups=
 
=Users & Groups=
The User and Groups section is where all the user management is done and where all the permissions are set up.  
+
<div class='floating_card'>The User and Groups section is where all the user management is done and where all the permissions are set up. </div>
  
[[File:ug1.jpg]]
+
{{img with key | file = ug1.jpg | list =
 
+
<li>Clicking on the '''Users & Groups''' link under '''Admin''' will take you to the section displayed above.</li>
#) Clicking on the '''Users & Groups''' link under '''Admin''' will take you to the section displayed above.
+
<li>Clicking on a group name will pull up the groups settings, clicking on the '''+''' next to a group will expand the group and reveal all the users associated with that group.</li>
#) Clicking on a group name will pull up the groups settings, clicking on the '''+''' next to a group will expand the group and reveal all the users associated with that group.
+
<li>Clicking on a user name will pull up the user settings.</li>
#) Clicking on a user name will pull up the user settings.
+
<li>The search box can be used to quickly find a user or group</li>
#) The search box can be used to quickly find a user or group
+
}}
  
 
==Group Management==
 
==Group Management==
  
[[File:ug2.jpg]]
+
{{img with key | file = ug2.jpg | list =
 +
<li>Clicking on '''Add Group''' pulls up the group section on the right shown above.</li>
 +
<li>Group Name: this is used as an identifier for the group.</li>
 +
<li>Container: this specifies the container the user group will use. Users are only able to see objects that are in the same container or a sub container.</li>
 +
<li>Additional Containers: this is used to specify additional containers, any users within a group that has multiple containers would be able to see objects within both.</li>
 +
<li>Marker Template: this specifies the default marker template users within this group will use.</li>
 +
<li>Additional Marker Templates: this is used to specify additional marker templates, the additional templates will show up in a drop down that can be selected when a user clicks the mark button.</li>
 +
<li>Information Template: this specifies the default information template users within this group will use.</li>
 +
<li>Additional Information Templates: this is used to specify additional information templates, the additional templates will show up in a drop down that can be selected when a user clicks the record / schedule button.</li>
 +
<li>Rights: this section is used to designate what a user can do within the software, clicking the '''+''' next to any of the sections will reveal all the sub-rights.</li>
 +
<li>Rooms: this is used to assign access to rooms for users within the group.  This access applies to both live and recorded video.</li>
 +
}}
  
#) Clicking on '''Add Group''' pulls up the group section on the right shown above.
+
{{img with key | file = ug3.jpg | list =
#) Group Name: this is used as an identifier for the group.
+
<li>Video Access: this section defines what videos users within this group have access to based on who authored the recordings. This applies to both live observation and review.</li>
#) Container: this specifies the container the user group will use. Users are only able to see objects that are in the same container or a sub container.
+
<li>Show Advanced Settings: clicking this link will expose additional user group settings.</li>
#) Additional Containers: this is used to specify additional containers, any users within a group that has multiple containers would be able to see objects within both.
+
}}
#) Marker Template: this specifies the default marker template users within this group will use.
 
#) Additional Marker Templates: this is used to specify additional marker templates, the additional templates will show up in a drop down that can be selected when a user clicks the mark button.
 
#) Information Template: this specifies the default information template users within this group will use.
 
#) Additional Information Templates: this is used to specify additional information templates, the additional templates will show up in a drop down that can be selected when a user clicks the record / schedule button.
 
#) Rights: this section is used to designate what a user can do within the software, clicking the '''+''' next to any of the sections will reveal all the sub-rights.
 
#) Rooms: this is used to assign access to rooms for users within the group.  This access applies to both live and recorded video.
 
  
[[File:ug3.jpg]]
+
{{img with key | file = ug4.jpg | list =
 +
<li>Retention Rule: this is used to define how long recordings are kept on the system before they are automatically deleted.  Changing this setting will retroactively affect existing recordings.</li>
 +
<li>I/O Record Name: if a user within this user group is configured to author a recordings started or stopped using a button this setting will create the default recording name for those recordings.</li>
 +
<li>Max Record Duration: this setting defines the maximum record length before a recording is automatically stopped.</li>
 +
<li>Default Views: for sections that offer different view layouts (list vs. thumbnail) the default preference for users within this group can be set here.</li>
 +
<li>Search Results Display: this is used to set the columns / information that is displayed at the top level when looking at the search results within the review section.</li>
 +
<li>Filters: filters are user specific by default but a filter (advanced search query) can be shared across a user group using this setting.</li>
 +
<li>Views: views are user specific by default but a view (custom camera layout) can be shared across a user group using this setting.</li>
 +
<li>Reports: reports are user specific by default but a report can be shared across a user group using this setting.</li>
 +
<li>Announcement: anything entered in this field will show up in the home screen under announcements for the users within the user group.</li>
 +
}}
  
#) Video Access: this section defines what videos users within this group have access to based on who authored the recordings.  This applies to both live observation and review.
+
{{img with key | file = ug5.jpg | list =
#) Show Advanced Settings: clicking this link will expose additional user group settings.
+
<li>Allow Access: this section can be used to restrict users to only be able to use the system during certain days or even certain times within certain days.</li>
 +
<li>Expiration Date: this can be used to remove access to the system for all users within the group on a certain date.</li>
 +
<li>Review list Default: this is the default number of days that are pulled up in the search query when a user within the group clicks the review button. The user can go back further to find older videos by adjusting the date range.</li>
 +
}}
  
[[File:ug4.jpg]]
+
{{img with key | file = ug6.jpg | list =
 +
<li>Clicking on '''Add User''' pulls up the user section on the right shown above.</li>
 +
<li>User Name: to create a local user account enter a user name.</li>
 +
<li>Password / Confirm: assign the user a password.</li>
 +
<li>Group: this specified the user group the user will be a part of.</li>
 +
<li>Additional Groups: this is used if the user will be a part of more than a single group.  From a rights and video access perspective, the settings within both groups will be merged.</li>
 +
<li>Show Advanced Settings: clicking this link will reveal additional user settings.</li>
 +
}}
  
#) Retention Rule: this is used to define how long recordings are kept on the system before they are automatically deleted.  Changing this setting will retroactively affect existing recordings.
+
{{img with key | file = ug7.jpg | list =
#) I/O Record Name: if a user within this user group is configured to author a recordings started or stopped using a button this setting will create the default recording name for those recordings.
+
<li>SAML IDP: this auto populates when an SSO / SAML user is imported and defines the IDP to be used to authenticate this user against.</li>
#) Max Record Duration: this setting defines the maximum record length before a recording is automatically stopped.
+
<li>Mobile Pin: this is used in conjunction with our BEAM application and provides a pin code that is associated with the user account for use with BEAM.</li>
#) Default Views: for sections that offer different view layouts (list vs. thumbnail) the default preference for users within this group can be set here.
+
<li>Control Type: this is used to change the PTZ control type for a user.</li>
#) Search Results Display: this is used to set the columns / information that is displayed at the top level when looking at the search results within the review section.
+
<li>Card Number: this is used in conjunction with card reader(s) so the system knows what card number should be associated with a user.</li>
#) Filters: filters are user specific by default but a filter (advanced search query) can be shared across a user group using this setting.
+
<li>Rooms: you can use this section to grant access to rooms, these would be in addition to what the user already has access to based on their user group.</li>
#) Views: views are user specific by default but a view (custom camera layout) can be shared across a user group using this setting.
+
<li>Display Name: this can be used so a different identifier is used throughout the system other than the actual account name.</li>
#) Reports: reports are user specific by default but a report can be shared across a user group using this setting.
+
<li>Video Access: this section is used to grant access to live / recorded video based on who authored it for the user, this is in addition to what they already have access to based on their user group.</li>
#) Announcement: anything entered in this field will show up in the home screen under announcements for the users within the user group.
+
<li>Allow Access: this section is used to grant / restrict access to the system during certain times / days.  This setting would be in addition to what is set on the group level.</li>
 
+
}}
[[File:ug5.jpg]]
 
 
 
#) Allow Access: this section can be used to restrict users to only be able to use the system during certain days or even certain times within certain days.
 
#) Expiration Date: this can be used to remove access to the system for all users within the group on a certain date.
 
#) Review list Default: this is the default number of days that are pulled up in the search query when a user within the group clicks the review button. The user can go back further to find older videos by adjusting the date range.
 
 
 
[[File:ug6.jpg]]
 
 
 
#) Clicking on '''Add User''' pulls up the user section on the right shown above.
 
#) User Name: to create a local user account enter a user name.
 
#) Password / Confirm: assign the user a password.
 
#) Group: this specified the user group the user will be a part of.
 
#) Additional Groups: this is used if the user will be a part of more than a single group.  From a rights and video access perspective, the settings within both groups will be merged.
 
#) Show Advanced Settings: clicking this link will reveal additional user settings.
 
 
 
[[File:ug7.jpg]]
 
 
 
#) SAML IDP: this auto populates when an SSO / SAML user is imported and defines the IDP to be used to authenticate this user against.
 
#) Mobile Pin: this is used in conjunction with our BEAM application and provides a pin code that is associated with the user account for use with BEAM.
 
#) Control Type: this is used to change the PTZ control type for a user.
 
#) Card Number: this is used in conjunction with card reader(s) so the system knows what card number should be associated with a user.
 
#) Rooms: you can use this section to grant access to rooms, these would be in addition to what the user already has access to based on their user group.
 
#) Display Name: this can be used so a different identifier is used throughout the system other than the actual account name.
 
#) Video Access: this section is used to grant access to live / recorded video based on who authored it for the user, this is in addition to what they already have access to based on their user group.
 
#) Allow Access: this section is used to grant / restrict access to the system during certain times / days.  This setting would be in addition to what is set on the group level.
 
  
 
==LDAP Management==
 
==LDAP Management==
  
[[File:ug8.jpg]]
+
{{img with key | file = ug8.jpg | list =
 
+
<li>Clicking on '''LDAP''' pulls up the user section on the right shown above.</li>
#) Clicking on '''LDAP''' pulls up the user section on the right shown above.
+
<li>LDAP User Account: this can be used to import a single LDAP user, you will need to enter the full DN of the user account excluding the DC information. Example: CN=dstern,OU=Users</li>
#) LDAP User Account: this can be used to import a single LDAP user, you will need to enter the full DN of the user account excluding the DC information. Example: CN=dstern,OU=Users
+
<li>Group to Add: this drop down menu is used to specify the group the LDAP user will be imported into.</li>
#) Group to Add: this drop down menu is used to specify the group the LDAP user will be imported into.
+
<li>Import Button: clicking this will query LDAP and import the specified user.</li>
#) Import Button: clicking this will query LDAP and import the specified user.
+
}}
 
 
[[File:ug9.jpg]]
 
  
#) Server: used to point to LDAP server / cluster using either the IP address or DNS name.
+
{{img with key | file = ug9.jpg | list =
#) LDAP Bind User: this is the account that will be used to bind / query LDAP.
+
<li>Server: used to point to LDAP server / cluster using either the IP address or DNS name.</li>
#) LDAP Bind Password: once the server, bind user, and password are entered pressing '''Save''' should result in a connected message.
+
<li>LDAP Bind User: this is the account that will be used to bind / query LDAP.</li>
#) LDAP Sync Schedules: clicking on an existing sync schedule will pull the settings up on the right as shown.  If no sync schedule is selected the settings will be blank.
+
<li>LDAP Bind Password: once the server, bind user, and password are entered pressing '''Save''' should result in a connected message.</li>
#) Name: this is an identifier for the sync schedule.
+
<li>LDAP Sync Schedules: clicking on an existing sync schedule will pull the settings up on the right as shown.  If no sync schedule is selected the settings will be blank.</li>
#) Container: this drop down menu is used to specify a container for the sync schedule (this does not affect the imported users but just the sync schedule object).
+
<li>Name: this is an identifier for the sync schedule.</li>
#) Bind Script: this is can be pointed to an OU or security group, the sync schedule will pull in all the matching user accounts. Example: CN=IVS_Admins,OU=User_Groups  
+
<li>Container: this drop down menu is used to specify a container for the sync schedule (this does not affect the imported users but just the sync schedule object).</li>
#) Group to Add: the users that match the bind script will be placed into this group automatically.
+
<li>Bind Script: this is can be pointed to an OU or security group, the sync schedule will pull in all the matching user accounts. Example: CN=IVS_Admins,OU=User_Groups </li>
#) Additional Groups: users that match the bind script will be placed into these groups as well.
+
<li>Group to Add: the users that match the bind script will be placed into this group automatically.</li>
#) Sync Type: the sync can be set to '''Automatic''' or '''Manual'''.  The automatic interval can be adjusted to any duration but is set to 24 hours by default.
+
<li>Additional Groups: users that match the bind script will be placed into these groups as well.</li>
#) Import: this button is used to execute the sync and bring in the matching LDAP user accounts.
+
<li>Sync Type: the sync can be set to '''Automatic''' or '''Manual'''.  The automatic interval can be adjusted to any duration but is set to 24 hours by default.</li>
 +
<li>Import: this button is used to execute the sync and bring in the matching LDAP user accounts.</li>
 +
}}
  
 
==SSO Configuration==
 
==SSO Configuration==
 
+
{{Section | content =  
VALT is compatible with SAML 2.0
+
{{:VALT SSO}}
 
+
}}
- Browse to the the Fully qualified domain name and sign in with a local account
 
 
 
- Click on admin
 
 
 
- Click on Users & Groups
 
 
 
- Along the top click on SSO and add SAML config
 
 
 
===To configure SSO VALT needs the following information:===
 
*Certificate in .cer format
 
*Identity Provider (IDP)
 
*Remote Sign-In URL
 
*Remote Sign-Out URL
 
*Display Name Attribute
 
*Any other custom attributes needed
 
[[File:SsoConfigInformation.png]]
 
 
 
After SSO is configured browse to <code>Replace with VALT Server Address/saml/metadata.xml</code> to grab the VALT metadata to add to your system
 
 
 
Items to Note:
 
*If moving from LDAP to SSO you have to add a custom attribute to map to the username so the usernames will match correctly
 
*To migrate current users to SSO the SQL command needs to be run on the database with the correct group ID
 
UPDATE users set ldap_sync_id = NULL, saml_config_id = 1, userType = 'local'  where deleted_at is null and group_id =
 
*Custom Attributes can be usernames if you want to map to something specific or other information that you want to pull into VALT
 
*Shibboleth IDP's need the following settings specified:
 
signAssertions: true
 
signResponses: true
 
encryptAssertions: false
 
encryptNameIDs: true
 
 
 
===User Mapping===
 
User mapping is used to map groups in the customer's system to groups within VALT
 
 
 
Required:
 
*Attribute (The item that gets passed back to VALT)
 
*User Value (The value of the item that gets passed back to VALT)
 
[[File:SAML_UserMapping.png]]
 
 
 
Items to Note:
 
*SSO in VALT is a one to one mapping for groups
 
  
 
==Import Users==
 
==Import Users==
  
[[File:ug11.jpg]]
+
{{img with key | file = ug11.jpg | list =
 
+
<li>Clicking '''Import Users''' pulls up the section on the right shown above</li>
#) Clicking '''Import Users''' pulls up the section on the right shown above
+
<li>Group to Add: this drop down menu defines the user group the imported users will be associated with.</li>
#) Group to Add: this drop down menu defines the user group the imported users will be associated with.
+
<li>Chose File: this button allows a user to browse to the file that contains the user data to be imported.</li>
#) Chose File: this button allows a user to browse to the file that contains the user data to be imported.
+
<li>Update: this button executes the import.</li>
#) Update: this button executes the import.
+
}}
  
 
==User Rights==
 
==User Rights==
The Valt system has a detailed user rights management system: almost every feature / function can be enabled or disabled based on requirements. Below is a list of the rights and an explanation on how each translates to the application.
+
<div class='floating_card'>The VALT system has a detailed user rights management system: almost every feature / function can be enabled or disabled based on requirements. Below is a list of the rights and an explanation on how each translates to the application.</div>
  
 
===Users & Groups Rights Table===
 
===Users & Groups Rights Table===
{| class="wikitable"
+
{| class="simple_table"
|style="font-style: bold; color: white; background-color:black;"|Permission
+
!Permission
|style="font-style: bold; color: white; background-color:black;"|Group
+
!Group
|style="font-style: bold; color: white; background-color:black;"|User     
+
!User     
 
|-
 
|-
 
|General
 
|General
Line 944: Line 910:
 
=Logs=
 
=Logs=
  
[[File:urlog1.jpg]]
+
{{img with key | file = urlog1.jpg | list =
 
+
<li>Clicking on the Logs link under '''Admin''' will take you to the section displayed above.</li>
#) Clicking on the Logs link under '''Admin''' will take you to the section displayed above.
+
<li>Start / End: this defines the date range of search results being displayed.</li>
#) Start / End: this defines the date range of search results being displayed.
+
<li>Search Box: typing information into this box will display matching results.</li>
#) Search Box: typing information into this box will display matching results.
+
<li>Export Button: clicking this button will allow a user to export the search results in either cvs or pdf format.</li>
#) Export Button: clicking this button will allow a user to export the search results in either cvs or pdf format.
+
<li>Some of the items in the logs will link to the items, these links will appear when you hover over the item as shown above.</li>
#) Some of the items in the logs will link to the items, these links will appear when you hover over the item as shown above.
+
<li>Users can navigate to different log types using the log submenu.</li>
#) Users can navigate to different log types using the log submenu.
+
<li>If more than one page of logs is available, the paginator in the bottom right can be used to cycle through the pages.</li>
#) If more than one page of logs is available, the paginator in the bottom right can be used to cycle through the pages.
+
}}

Latest revision as of 09:32, 8 May 2024

General

The general section under Admin provides a snapshot of the software along with some management links as shown below.

Gen-1.jpg

  1. Admin: if a user has administrative rights they will be able to click on the Admin section.
  2. General Link: the default section that will load once a user clicks on admin is General assuming they have access to this Admin section. The general system provides some basic application and system information.
  3. Software Information: this displays the software version, license type, number of licenses and a link to a database management tool (phpmyadmin).
  4. Global Settings: this allows a user to toggle settings that apply to all users. The date format and video streaming method for live observation.
  5. Email Settings: these are the connection settings to be used for email alerts.
  6. Media Server(s): this displays all the media servers associated with the software instance, the amount of storage used / remaining on each, and a management link for the video engine on each media server. Note if a media server is online it will have a green name, if it is offline the name will appear in red as shown above.
  7. Customization: this allows a user to customize the login page with alternative graphics and links.

Templates

Templates within VALT are used to tie searchable & reportable information to videos. A template(s) is assigned to a user group, where when that user starts or schedules a recording their set of templates will automatically get assigned to the associated recording(s). There are three types of templates listed below (Information, Marker, Evaluation). Each template type has a set of fields that can be used in the creation of the template. A template can consist of any number of fields and field types. These templates can be created and customized to meet a wide range of unique applications and workflows.

Information Templates

Information forms are typically used at the start of a recording to define information about that recording. Information templates can also be modified in the review section after a recording has been completed.

Information Field Types

When creating or modifying an information template there are a variety of field types that can be used. See below for reference.

Information-field.jpg

  1. Text: This field is a freeform text box with a title. This field is limited to 128 characters.
  2. Files: This field adds a button to the template that allows users to upload any number of .pdf, docx, and xlsx files. These files generate links within the template that can be used to download the uploaded files.
  3. Quick Record: This field creates a titled clickable button on the information form. If a user clicks this button it titles the recording with the button name and bypasses // ignores all other fields.
  4. Drop Down: This field is a drop down list with a title. Any number of drop down options can be defined, but only a single one can be selected when a user is filling out the template.
  5. Multi-Select: This field is a searchable drop down list with a title. Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.
  6. Audio: This field is freeform text box with a title that includes icons for recording an audio note. If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.
  7. Note: This field is a larger freeform text box with a title. This field is limited to 500 characters.

Creating a New Information Template

Template new.jpg

  1. Click the Admin button on the main navigation menu.
  2. Select Templates.
  3. Press Add Template.
  4. Enter a template name.
  5. Select the template type (Information).
  6. Select the container.

Template new2.jpg

  1. The Add Field button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.
  2. To enable a field within a template, the On checkbox must be checked.
  3. This dialog box is used to title the field.
  4. If the Req box is checked for the field it forces the user to input data into that field.
  5. This drop down box defines the field type.
  6. This dialog box can be set to pre-populate the template form with data for that field.
  7. This Edit button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the Notes text box field on the Information template form.
  8. This button deactivates the template so it is not shown and cannot be applied to user groups.
  9. This button saves the template.
  10. This button deletes the template, this button will only appear if there are no user groups using this template and if no recordings or schedules have been created using this template. If any of those conditions are true the only option to remove the template would be to deactivate (hide) the template.

Marker Templates

Markers are used to tie information to specific points in a recording. Markers can be added during a recording or after the fact when reviewing a video recording. Markers create key point within the video that allow users to easily jump right to that point within a longer video (much like chapters in a DVD). The data associated with a marker can be overlaid as text on the video during playback.

Marker Field Types

Marker-field.jpg

  1. Text: This field is a freeform text box with a title. This field is limited to 128 characters.
  2. Drop Down: This field is a dropdown list with a title. Any number of drop down options can be defined but only a single one can be selected when a user is filling out the marker form.
  3. Audio: This field is freeform text box with a title that includes icons for recording an audio note. If a recorded audio note is present, the user will have the option to play it back or delete it using associated icons.
  4. Multi-Select: This field is a searchable drop down list with a title. Any number of drop down options can be defined, and any number can be selected when a user is filling out this template.
  5. Note: This field is a larger freeform text box with a title. This field is limited to 500 characters.
  6. Quick Mark: This field creates a titled clickable button on the marker form. If a user clicks this button, it inserts a marker and titles the marker with the button this action bypasses // ignores all other fields.

Continous-field.jpg

  1. Continous Marker: This field is only available as the first field within the marker template. Changing to this changes the formatting of the marker. When the mark button is pressed it brings up the form as shown below and changes the behavior. To insert a marker a user can now simply type and press enter. The marker is always inserted when they begin to type. This method is generally used when the workflow requires that many markers are being inserted.

Creating a New Marker Template

Marker-template.jpg

  1. Click the Admin button on the main navigation menu.
  2. Select Templates.
  3. Press Add Template.
  4. Enter a template name.
  5. Select the template type (Information).
  6. Select the container.

Marker-template1.jpg

  1. The Add Field button is used to create new fields within the template as shown above. There is no limit to the number of fields you can associate with a single template.
  2. To enable a field within a template form the On checkbox must be checked.
  3. This dialog box is used to title the field.
  4. If the Req box is checked for the field it forces the user to input data into that field.
  5. This drop down box defines the field type.
  6. This dialog box can be set to pre-populate the template form with data for that field.
  7. This button is used to define the marker color that shows up on the timeline when a marker is inserted.
  8. This Edit button is used to launch the editor. This button appears for Drop Down, Multi-Select & Notes field types. For Drop Down & Multi-Select fields, it is used to define the user options within the form. This can be done by seperating each option with a comma as shown above. For the notes field, it can be used to pre-populate the data within the notes text box field on the information template form.
  9. This button deactivates the template so it is not shown and cannot be applied to user groups.
  10. This button saves the template.
  11. This button deletes the template and will only appear if there are no user groups using this template, and if no recordings or schedules have been created using this template. If any of those conditions are true, the only option to remove the template would be to deactivate (hide) the template.

Evaluation Templates

Evaluation templates are typically used during a recording, or after a recording is completed. An evaluation form acts much like an information form in that it is used to tie a single set of information into the recording. The big difference between an evaluation and information form is that numeric values can be assigned to the fields within an evaluation form. This allows scoring to be done on each item and the overall form. Evaluation also allow unique reports to be run against them that are based on score %.


Evaluation Template Fields

When creating or modifying an evaluation template, there are a variety of field types that can be used. See below for reference.

Eval-field.jpg

  1. Description: This field is a larger freeform text box with a question. This field is limited to 500 characters and allows the numerical value or score to be entered in the box below.
  2. Single select: This field consists of radio button(s) each with a description and associated score. This field type allows a user to select a single option as shown below.
  3. Multi Checkbox: This field consists of checkboxes each with a description and associated score. This field type allows a user to select multiple boxes as shown below.

Creating a New Evaluation Template

Eval-1.jpg

  1. Select Evaluation as the template type
  2. Add and name fields appropriately
  3. Select the field type, options include: Single Select, Multi Checkbox and Description.
  4. Edit button allows the user to enter the value along with options.
  5. Delete button deletes the field.

Eval-2.jpg

  1. Add Option: this button adds additional options to the field.
  2. Allow Markers: this checkbox allows users to plot and call markers from this field within the evaluation form.
  3. This dialog box defines the total maximum point value for the field.
  4. This dialog box is used to name the option.
  5. This dialog box defines the point value for the associated option.
  6. Press Save to save the field, note once the template is complete the user will also press save at the template level.

Assigning a Template

Templates are always assigned to user groups, with the individual users then being added to the user groups

Assign template.jpg

  1. Click the Admin button on the main navigation menu.
  2. Select Users & Groups.
  3. Click on the user group.
  4. Select a default marker template using the drop down menu, and additional marker templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.
  5. Select a default information template using the drop down menu, and additional information templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recording or schedule.
  6. Select a default evaluation template using the drop down menu, and additional evaluation templates can be added in the dialog box below allowing the user(s) to select a different template to be used for a specific recorded video.


Rooms

Rooms act as containers for a camera or group of cameras. Rooms can be recorded using a contact closure / card reader, schedule, or on demand through the user interface. Rooms are also assignable from a user permission perspective.

Roo1.jpg

  1. Clicking on the Rooms link under Admin will take you to the section displayed above.
  2. Clicking on a room name will allow a user to edit the room name / settings.
  3. Expanding a room will reveal the camera(s) associated with a room, while clicking on a camera will allow a user to edit the camera name / settings.
Clicking on a room name or clicking Add Room will pull up the room settings as shown below.

Roo2.jpg

  1. Room Name: a room name can be entered here. This name will be the identifier that will be used throughout the rest of the system.
  2. Container: this specifies the container the template will use. Users are only able to see objects that are in the same container or a sub container.
  3. Cameras: this is used to associate cameras to a room.
  4. View Type: this can be used to define a view type default for the room, if no option is selected the system will automatically use the assumed best fit view type for the number of cameras.
  5. Use I/O: this checkbox should be checked if you are using a push button to start / stop recordings. When this is checked a sub menu with options will appear.
  6. Save / Delete: Once a room is configured pressing Save will save the changes.
Clicking on a camera name or clicking Add Camera will pull up the camera settings shown below.

Roo3.jpg

  1. Add Camera: to add a new camera click the Add Camera button, if the system has available device licenses available a menu will pop up as shown above.
  2. Camera Name: this is a label that can be assigned to the camera, this name will be used throughout the rest of the system.
  3. IP: the DNS name or IP address of the camera should be entered here.
  4. HTTP Port: this is the port that will be used to authenticate to the camera (note: the default should be 80 unless changed within the camera).
  5. RTSP Port: this is the port that will be used to stream video between the camera and server (note: the default should be 554 unless changed within the camera).
  6. Username / Password: enter a admin username and password for the camera.
  7. Rooms: this can be used to assign the camera to room(s).
  8. Camera Control Color: the control color can be changed using this color picker. Controls are overlaid on top of the video when enabled and include digital zoom and PTZ.
  9. Media Server: this option is used to define what server the camera is connected to.
  10. Brand: this drop down specifies what camera type is being used.
  11. Model: this drop down specifies what model camera is being used.
  12. Save: once the camera settings are set pressing Save will commit the settings / changes.
Clicking on a camera name or clicking Add Device will pull up the device settings shown below.

Roo4.jpg

  1. Add Device: to add a new device click the Add Device button, if the system has available device licenses available a menu will pop up as shown above.
  2. Device UID: if an iPhone / iPad is being added the device UID will need to be entered on the client side.
  3. Rooms: this is used to add the device to room(s).
  4. Device Name: this is a label that can be assigned to the device. This name will be used throughout the rest of the system.
  5. Device Type: this is used to define the type of device.
  6. Save / Delete: make sure to click Save after settings are changed to commit the changes.

Containers

Containers are used to segment objects. A user is only able to see objects (rooms, templates, user groups) in their container or a sub container. Containers are typically implemented when multiple departments with administrator(s) of each department are sharing a single software instance.

Cont1.jpg

  1. Clicking on the Containers link under Admin will take you to the section displayed above.
  2. Add Container: clicking on Add Container brings up the menu shown on the right above.
  3. Container Name: this is the container identifier for the container throughout the rest of the system.
  4. Parent Container: users have access to sub containers but not parent containers. To place a container under another use the Parent Container drop down menu.
  5. Save / Delete: Once a container is configured click Save to commit the changes.

Media Server

Media servers are used to stream video / connect to cameras and store video.

Meds1.jpg

  1. Clicking on the Media Server link under Admin will take you to the section displayed above.
  2. Add Media Server: clicking on Add Container brings up the menu shown on the right above.
  3. This lists all the existing media servers configured for the software instance.
  4. Media Server Name: this is an identifier used throughout the system.
  5. Address: the IP address or DNS name of the server.
  6. SSL Port: if encrypted video is desired this designates the default port used (note: 444 is the default unless otherwise specified within configuration files and server firewall).
  7. SSL: this checkbox enables video encryption.
  8. Storage Folder: this designates the folder name that the video will be stored in (note: default is valt_recordings unless otherwise specified).
  9. Save function

Transcription

Prior to setting up transcription you will need an Amazon AWS account, an S3 storage bucket and a Access ID & Secret Key for API access.

AWS Transcription Setup

Transcribe 1.png

  • Log into AWS with a root level account
  • Click on the "S3" Storage service

Transcribe 2.png

  • Press the "Create New Bucket" button

Transcribe 3.png

  • Give the bucket a name
  • Click the "Save" button

Transcribe 4.png

  • Click on the account name then select "My Security Credentials"

Transcribe 5.png

  • Click on the "Create New Access Key" button

Transcribe 6.png

  • Download and save the Key file (you will need this to configure VALT later)

VALT Transcription Setup

Transcribe 7.png

  1. Click on the "Admin" section then select "Transcription"
  2. Click on "Add Transcription Service"
  3. Enter a name (this is just a unique identifier used by VALT)
  4. Enter the Access Key ID gathered from AWS
  5. Enter the Secret Key that matches the Access Key from AWS
  6. Select the Region that the AWS bucket is set within
  7. Click "Save"

Transcribe 8.png

  1. Click on the "Admin" section then select "Media Servers"
  2. Click on a media server you want to associate with the newly created transcription service
  3. Click on the "Transcription Service" drop down and select the name of the transcription service
  4. Click "Save"

Users & Groups

The User and Groups section is where all the user management is done and where all the permissions are set up.

Ug1.jpg

  1. Clicking on the Users & Groups link under Admin will take you to the section displayed above.
  2. Clicking on a group name will pull up the groups settings, clicking on the + next to a group will expand the group and reveal all the users associated with that group.
  3. Clicking on a user name will pull up the user settings.
  4. The search box can be used to quickly find a user or group

Group Management

Ug2.jpg

  1. Clicking on Add Group pulls up the group section on the right shown above.
  2. Group Name: this is used as an identifier for the group.
  3. Container: this specifies the container the user group will use. Users are only able to see objects that are in the same container or a sub container.
  4. Additional Containers: this is used to specify additional containers, any users within a group that has multiple containers would be able to see objects within both.
  5. Marker Template: this specifies the default marker template users within this group will use.
  6. Additional Marker Templates: this is used to specify additional marker templates, the additional templates will show up in a drop down that can be selected when a user clicks the mark button.
  7. Information Template: this specifies the default information template users within this group will use.
  8. Additional Information Templates: this is used to specify additional information templates, the additional templates will show up in a drop down that can be selected when a user clicks the record / schedule button.
  9. Rights: this section is used to designate what a user can do within the software, clicking the + next to any of the sections will reveal all the sub-rights.
  10. Rooms: this is used to assign access to rooms for users within the group. This access applies to both live and recorded video.

Ug3.jpg

  1. Video Access: this section defines what videos users within this group have access to based on who authored the recordings. This applies to both live observation and review.
  2. Show Advanced Settings: clicking this link will expose additional user group settings.

Ug4.jpg

  1. Retention Rule: this is used to define how long recordings are kept on the system before they are automatically deleted. Changing this setting will retroactively affect existing recordings.
  2. I/O Record Name: if a user within this user group is configured to author a recordings started or stopped using a button this setting will create the default recording name for those recordings.
  3. Max Record Duration: this setting defines the maximum record length before a recording is automatically stopped.
  4. Default Views: for sections that offer different view layouts (list vs. thumbnail) the default preference for users within this group can be set here.
  5. Search Results Display: this is used to set the columns / information that is displayed at the top level when looking at the search results within the review section.
  6. Filters: filters are user specific by default but a filter (advanced search query) can be shared across a user group using this setting.
  7. Views: views are user specific by default but a view (custom camera layout) can be shared across a user group using this setting.
  8. Reports: reports are user specific by default but a report can be shared across a user group using this setting.
  9. Announcement: anything entered in this field will show up in the home screen under announcements for the users within the user group.

Ug5.jpg

  1. Allow Access: this section can be used to restrict users to only be able to use the system during certain days or even certain times within certain days.
  2. Expiration Date: this can be used to remove access to the system for all users within the group on a certain date.
  3. Review list Default: this is the default number of days that are pulled up in the search query when a user within the group clicks the review button. The user can go back further to find older videos by adjusting the date range.

Ug6.jpg

  1. Clicking on Add User pulls up the user section on the right shown above.
  2. User Name: to create a local user account enter a user name.
  3. Password / Confirm: assign the user a password.
  4. Group: this specified the user group the user will be a part of.
  5. Additional Groups: this is used if the user will be a part of more than a single group. From a rights and video access perspective, the settings within both groups will be merged.
  6. Show Advanced Settings: clicking this link will reveal additional user settings.

Ug7.jpg

  1. SAML IDP: this auto populates when an SSO / SAML user is imported and defines the IDP to be used to authenticate this user against.
  2. Mobile Pin: this is used in conjunction with our BEAM application and provides a pin code that is associated with the user account for use with BEAM.
  3. Control Type: this is used to change the PTZ control type for a user.
  4. Card Number: this is used in conjunction with card reader(s) so the system knows what card number should be associated with a user.
  5. Rooms: you can use this section to grant access to rooms, these would be in addition to what the user already has access to based on their user group.
  6. Display Name: this can be used so a different identifier is used throughout the system other than the actual account name.
  7. Video Access: this section is used to grant access to live / recorded video based on who authored it for the user, this is in addition to what they already have access to based on their user group.
  8. Allow Access: this section is used to grant / restrict access to the system during certain times / days. This setting would be in addition to what is set on the group level.

LDAP Management

Ug8.jpg

  1. Clicking on LDAP pulls up the user section on the right shown above.
  2. LDAP User Account: this can be used to import a single LDAP user, you will need to enter the full DN of the user account excluding the DC information. Example: CN=dstern,OU=Users
  3. Group to Add: this drop down menu is used to specify the group the LDAP user will be imported into.
  4. Import Button: clicking this will query LDAP and import the specified user.

Ug9.jpg

  1. Server: used to point to LDAP server / cluster using either the IP address or DNS name.
  2. LDAP Bind User: this is the account that will be used to bind / query LDAP.
  3. LDAP Bind Password: once the server, bind user, and password are entered pressing Save should result in a connected message.
  4. LDAP Sync Schedules: clicking on an existing sync schedule will pull the settings up on the right as shown. If no sync schedule is selected the settings will be blank.
  5. Name: this is an identifier for the sync schedule.
  6. Container: this drop down menu is used to specify a container for the sync schedule (this does not affect the imported users but just the sync schedule object).
  7. Bind Script: this is can be pointed to an OU or security group, the sync schedule will pull in all the matching user accounts. Example: CN=IVS_Admins,OU=User_Groups
  8. Group to Add: the users that match the bind script will be placed into this group automatically.
  9. Additional Groups: users that match the bind script will be placed into these groups as well.
  10. Sync Type: the sync can be set to Automatic or Manual. The automatic interval can be adjusted to any duration but is set to 24 hours by default.
  11. Import: this button is used to execute the sync and bring in the matching LDAP user accounts.

SSO Configuration

VALT is capable of integrating with Single Sign-On (SSO) authentication. Use the links below to understand VALT's SSO requirements and to look at our configuration information!


Import Users

Ug11.jpg

  1. Clicking Import Users pulls up the section on the right shown above
  2. Group to Add: this drop down menu defines the user group the imported users will be associated with.
  3. Chose File: this button allows a user to browse to the file that contains the user data to be imported.
  4. Update: this button executes the import.

User Rights

The VALT system has a detailed user rights management system: almost every feature / function can be enabled or disabled based on requirements. Below is a list of the rights and an explanation on how each translates to the application.

Users & Groups Rights Table

Permission Group User
General X
General: Home X
General: Alert X
General: Edit Profile X
General: Change Password X
General: Password Rules X
General: Notifications X
Upload X
Upload: Sharing X
Upload: Author X
Upload: Retention X
Observe X
Observe: Recording X
Observe: Recording: Start X
Observe: Recording: Prepare X
Observe: Recording: Pause X
Observe: Recording: Pause: All Authors X
Observe: Recording: Pause: Resume All Authors X
Observe: Recording: Stop All Authors X
Observe: Recording: Sharing X
Observe: Recording: Evaluation X
Observe: Recording: Evaluation: View Option Values X
Observe: Recording: Evaluation: View Field Values X
Observe: Recording: Evaluation: View Total Values X
Observe: Recording: Change Author X
Observe: Recording: Retention X
Observe: Recording: Options X
Observe: Recording: Options: All Authors X
Observe: Recording: Add Markers X
Observe: Recording: Delete Markers X
Observe: Recording: Prepare X
Observe: Recording: Pause X
Observe: Recording: Pause: All Authors X
Observe: Recording: Pause: Resume All Authors X
Observe: Search X
Observe: Multi-Record X
Observe: Views X
Observe: Views: Recording X
Observe: Talkback X
Observe: PTZ X
Observe: PTZ: Control X
Observe: PTZ: All Authors X
Observe: PTZ: Presets X
Observe: PTZ: Add/Delete X
Observe: Lock X
Observe: Lock: Unlock all Users X
Observe: Edit Sharing X
Observe: Edit Sharing: Create Link X
Review X
Review: Markers X
Review: Markers: View All Authors X
Review: Markers: Add X
Review: Markers: Edit X
Review: Markers: Remove X
Review: Markers: Overlay X
Review: Tools X
Review: Tools: Clip X
Review: Tools: Redact X
Review: Delete X
Review: Download X
Review: Download: Audio X
Review: Download: Multiview X
Review: Change Author X
Review: Edit Information X
Review: Evaluation X
Review: Evaluation: View Option Values X
Review: Evaluation: View Field Values X
Review: Evaluation: View Total Value X
Review: Evaluation: Edit X
Review: Edit Sharing X
Review: Edit Sharing: Link X
Review: Change Author X
Review: Edit Retention X
Schedule X
Schedule: Add X
Schedule: Exceptions X
Schedule: Edit X
Schedule: Edit: All Authors X
Schedule: Delete X
Schedule: Sharing X
Schedule: Change Author X
Schedule: Retention X
Schedule: Control X
Schedule: View All Authors X
Reports X
Reports: Add X
Reports: Edit X
Reports: Delete X
Admin X
Admin: General X
Admin: General: Software Information X
Admin: General: Global Settings X
Admin: General: Media Servers X
Admin: General: Customization X
Admin: Templates X
Admin: Rooms X
Admin: Users & Groups X
Admin: Users & Groups: LDAP X
Admin: Users & Groups: LDAP: User Import X
Admin: Users & Groups: LDAP: Servers X
Admin: Users & Groups: LDAP: Sync Schedules X
Admin: Users & Groups: SSO X
Admin: Logs X
Admin: Help X
Admin: Media Servers X
Admin: Containers X
Admin: Update X
Admin: Multi-Delete X
Rooms X X
Video Access X X
Default Retention Rule X
I/O Record Name X
Max Record Duration X
Schedule View X
Reports View X
Search Results View X
Search Results Display Columns X
Filters X
Views X
Restricted Access X X
Expiration Date X X
Review List Period X
Email X
Mobile PIN X
Card Number X
SSO/SAML IDP X
Display Name X
Control Type X

Logs

Urlog1.jpg

  1. Clicking on the Logs link under Admin will take you to the section displayed above.
  2. Start / End: this defines the date range of search results being displayed.
  3. Search Box: typing information into this box will display matching results.
  4. Export Button: clicking this button will allow a user to export the search results in either cvs or pdf format.
  5. Some of the items in the logs will link to the items, these links will appear when you hover over the item as shown above.
  6. Users can navigate to different log types using the log submenu.
  7. If more than one page of logs is available, the paginator in the bottom right can be used to cycle through the pages.