Difference between revisions of "VALT User Training Guide - Templates"

From IVS Wiki
Jump to: navigation, search
 
(51 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Article - Manual | content =  
 
{{Article - Manual | content =  
 
<h1>Overview</h1>
 
<h1>Overview</h1>
−
Information templates are used to structure data entered into the system. Users are prompted to complete an information template when they press the <b>Record</b>, <b>Prepare</b>, or <b>Schedule</b> buttons. Each template can have multiple data fields, but at least one field is [[#Required Fields|required]]. Users can be assigned multiple templates as needed.
+
Templates are used to tie searchable and reportable information to videos. When that user starts or schedules a recording their set of templates will automatically get assigned to the associated recording(s).
 +
 
 +
 
 +
There are four types of templates:
 +
*[[#Information Templates|Information]]
 +
*[[#Evaluation Templates|Evaluation]]
 +
*[[#Comment Templates|Comment]]
 +
*[[#Quick Marker Templates|Quick Marker]]
 +
 
 +
 
 +
Templates can be created and customized to meet a wide range of unique applications and workflows. Each template type has a different set of fields that can be used for organizing information. A template can consist of any number of fields and field types.
 +
 
 +
 
 +
Each template can have multiple data fields, but at least one field is [[#Required Fields|required]]. Users can be assigned multiple templates as needed. 
 +
 
 +
{{Aside - Helpful | content = Templates are assigned to a user group.}}
 +
 
 +
{{hr}}
 +
 
 +
<h1>Information Templates</h1>
 +
Information templates are used to structure data entered into the system. Users are prompted to complete an information template when they press the <b>Record</b>, <b>Prepare</b>, or <b>Schedule</b> buttons.
 +
 
 +
{{img - resize | file = VALT 6.3 Manual-Observe 13.png}}
  
 
{{Aside | content = Only admin-level users can create, edit, and assign information templates.}}   
 
{{Aside | content = Only admin-level users can create, edit, and assign information templates.}}   
  
−
{{hr - 2}} 
 
  
 
There are a variety of field types available when generating information templates. These field types are used to control and guide users in entering the correct information and associating it with recordings. The available field types include:
 
There are a variety of field types available when generating information templates. These field types are used to control and guide users in entering the correct information and associating it with recordings. The available field types include:
  
 
#[[#Text|Text]]   
 
#[[#Text|Text]]   
−
#[[#Drop-Down|Drop-Down]]   
+
#[[#Drop Down|Drop Down]]   
−
#[[#Notes|Notes]]   
+
#[[#Note|Note]]   
−
#[[#Audio Notes|Audio Notes]]   
+
#[[#Audio|Audio]]   
 
#[[#Multi-Select|Multi-Select]]   
 
#[[#Multi-Select|Multi-Select]]   
 
#[[#Image|Image]]   
 
#[[#Image|Image]]   
Line 18: Line 39:
 
#[[#Static Text|Static Text]]   
 
#[[#Static Text|Static Text]]   
  
 +
 +
{{Top of Page}}
 
{{hr}}   
 
{{hr}}   
  
−
<h1>Field Types Explained</h1> 
+
{{Manual lvl 2 | title = Information Field Types | content =
 +
When creating or modifying an information template, there are a variety of field types that can be used. See below for reference.}}
  
−
==Text== 
+
{{hr - 2}} 
−
Text fields allow users to enter free-form text into a single-line input box. There is a 255-character limit on a text field, but any characters can be used.
+
 
 +
{{Manual lvl 3 | title = Text | content = {{Text Field Description 6.3}} }}
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
==Drop-Down== 
+
{{Manual lvl 3 | title = Drop Down | content = {{Drop Down Field Description 6.3}} }}
−
Drop-down fields provide users with a predefined list of options, allowing them to select only one item.
 
−
{{Aside - Warning | hue = 50 | content = When names of people are used in a drop-down, they are in no way associated with a users' account.}}
 
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
==Notes== 
+
{{Manual lvl 3 | title = Note | content = {{Note Field Description 6.3}} }}
−
Notes fields are used when users need a larger space to input more data. The notes field has built-in text wrapping, ensuring users can always see what they have typed. There is no character limit in a notes field. 
 
−
{{Aside - Helpful | content = A general note field can be helpful at the end of a template for users to assign more information to a video that does not fit the other categories in the template.}}
 
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
==Audio Notes== 
+
{{Manual lvl 3 | title = Audio | content = {{Audio Notes Field Description 6.3}} }}
−
Audio notes fields allow users to associate audio recordings with the information in a recording. Note that the audio is not indexed or searchable. Audio is recorded using the client PC microphone or headset.  
+
 
 +
{{hr - 2}}  
  
−
To create an audio note: 
+
{{Manual lvl 3 | title = Multi-Select | content = {{Multi-Select Field Description 6.3}} }}
−
#Click the {{Add Button 2 | color = #ffab3e}} '<strong>Add audio</strong>' button.
 
−
#:<em>If not already enabled, your browser may request you <u>Allow Access</u> for microphone usage.</em>
 
−
#Speak your notes.
 
−
#When done, click the {{Add Button 2 | color = #ffab3e | icon = &#8226;}} '<strong>stop recording</strong>' button.
 
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
{{Manual lvl 2 | title = Multi-Select | content =   
+
{{Manual lvl 3 | title = Image | content = {{Image Field Description 6.3}}
−
Multi-Select fields allow users to select multiple options from a predefined list.
+
 
−
}}
+
{{hr - 2}}
 +
 
 +
<center>[https://fast.wistia.com/embed/channel/woi6yb17bx?wchannelid=woi6yb17bx&wmediaid=v5ge33royi &#9654;&#65039; Watch our brief video on the <strong>Image Field</strong>!]</center>
 +
 
 +
}}
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
==Image== 
+
{{Manual lvl 3 | title = File | content = {{File Field Description 6.3}} }}
−
Image fields allow users to add a static image to their template. The image will be displayed as part of the information associated with the recording.
 
  
 
{{hr - 2}}   
 
{{hr - 2}}   
  
−
==File== 
+
{{Manual lvl 3 | title = Static Text| content = {{Static Text Field Description 6.3}} }}
−
File fields allow users to upload files to the template.
 
−
{{Aside | content = The allowed file types will be listed within your VALT system, including **.pdf, .xlsx, .doc**, etc.}}
 
  
−
{{hr - 2}} 
 
  
−
==Static Text== 
 
−
Static text fields are used to display text that describes a scenario or outlines requirements for how users should fill out the template. This text cannot be edited by the user. 
 
  
 +
{{Top of Page}}
 
{{hr}}   
 
{{hr}}   
 +
 +
<h1>Evaluation Templates</h1>
 +
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 template 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 <em>(%)</em>.
 +
 +
 +
{{Aside - Helpful | content = As of VALT 6.3, you're now able to <b>add more than one</b> evaluation template to a single recording!
 +
 +
<center>[https://fast.wistia.com/embed/channel/woi6yb17bx?wchannelid=woi6yb17bx&wmediaid=j3k898ifyt &#9654;&#65039; Watch our video about it]!</center>
 +
<br>
 +
}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
{{Manual lvl 2 | title = Evaluation Field Types | content =
 +
When creating or modifying an evaluation template, there are a variety of field types that can be used.
 +
 +
 +
The four types of fields are:
 +
*[[#Image_2|Image]]
 +
*[[#Single Select|Single Select]]
 +
*[[#Multi-Select_2|Multi-Select]]
 +
*[[#Description|Description]]
 +
*[[#Static Text_2|Static Text]]
 +
{{img - resize | file = VALT 6.3 Manual-Observe 15.png}}
 +
}}
 +
 +
 +
{{Manual lvl 3 | title = Image | content =
 +
This field allows you to attach images to an evaluation. This can often help provide additional context to your form.
 +
 +
<center>{{img | file = VALT 6.3 Manual-Observe Eval Image.png}}</center>
 +
 +
{{hr - 2}}
 +
 +
<center>[https://fast.wistia.com/embed/channel/woi6yb17bx?wchannelid=woi6yb17bx&wmediaid=v5ge33royi &#9654;&#65039; Watch our brief video on the <strong>Image Field</strong>!]</center>
 +
}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Single Select | content =
 +
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.
 +
 +
<center>{{img | file = VALT 6.3 Manual-Observe Eval Single-Select.png}}</center>
 +
}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Multi-Select | content =
 +
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.
 +
 +
<center>{{img | file = VALT 6.3 Manual-Observe Eval Multi-Select.png}}</center>
 +
}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Description | content =
 +
Description fields are larger freeform text boxes. This field is limited to 500 characters and allows the numerical value or score to be entered in the box below.
 +
 +
<center>{{img | file = VALT 6.3 Manual-Observe Eval Description.png}}</center>
 +
}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Static Text | content =
 +
Static fields can be used to describe sections of an evaluation.
 +
 +
<center>{{img | file = VALT 6.3 Manual-Observe Eval Static.png}}</center>
 +
}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
<h1>Comment Templates</h1>
 +
Comment templates can be made to structure multiple fields of information when adding a comment. Users can fill out a comment template during live observation or when reviewing a recorded video. A comment template can include multiple data fields but must have at least one.
 +
 +
{{img - resize | file = VALT 6.3 Manual-Observe 14.png}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
{{Manual lvl 2 | title = Comment Field Types  | content =
 +
#[[#Text_2|Text]] 
 +
#[[#Drop Down_2|Drop Down]] 
 +
#[[#Note_2|Note]] 
 +
#[[#Multi-Select_3|Multi-Select]] 
 +
}}
 +
 +
 +
{{Manual lvl 3 | title = Text | content = {{Text Field Description 6.3}} }}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Drop Down | content = {{Drop Down Field Description 6.3}} }}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Note | content = {{Note Field Description 6.3}} }}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Multi-Select | content = {{Multi-Select Field Description 6.3}} }}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
<h1>Quick Marker Templates</h1>
 +
Quick Markers are used to simplify and standardize the use of frequently referenced markers and comments.
 +
 +
{{img - resize | file = VALT 6.3 Manual-Observe 16.png}}
 +
 +
{{Manual lvl 2 | title = Field Types | content = For marker templates, there is only one field type {{dash}} [[#Marker|Marker]].}}
 +
 +
 +
{{Manual lvl 3 | title = Marker | content =
 +
The marker field allows you to assign a key word to a colored flag that will be easily found on the timeline in the review section.
 +
<center>{{img - resize | file = VALT 6.3 Manual Templates 00.png | width = 650px}}</center>
 +
 +
{{Aside | content = Mutiple quick markers can be added to one template.}}
 +
}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
  
 
<h1>Additional Information</h1>
 
<h1>Additional Information</h1>
  
 
{{Manual lvl 2 | title = Required Fields | content =  
 
{{Manual lvl 2 | title = Required Fields | content =  
−
When starting a recording, at minimum, the first field <u>must be</u> filled out. Additional fields may also be set as required before starting a recording.
+
When starting a recording, at minimum, the first field <u><em>must be</em></u> filled out. Additional fields may also be set as required before starting a recording.}}
 +
 
  
−
<dl>
+
{{Manual lvl 3 | title = Optional | content =
−
<dt>Optional</dt>
+
This field type can be filled out or left blank.}}
−
<dd>This field type can be filled out or left blank.</dd>
 
−
<dt>Required</dt>
 
−
<dd>This field type must be completed before the user can start recording, prepare, or schedule.</dd>
 
−
<dt>Pre-filled</dt>
 
−
<dd>This field type contains predefined text but can be modified. If left unchanged, it will automatically populate with the default text.</dd>
 
−
</dl>
 
−
}}
 
  
 
{{hr - 2}}
 
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Required  | content =
 +
This field type must be completed before the user can start recording, prepare, or schedule.}}
 +
 +
{{hr - 2}}
 +
 +
{{Manual lvl 3 | title = Pre-filled | content =
 +
This field type contains predefined text but can be modified. If left unchanged, it will automatically populate with the default text.}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
  
 
{{Manual lvl 2 | title = Changing Information Templates | content =  
 
{{Manual lvl 2 | title = Changing Information Templates | content =  
Line 93: Line 244:
  
 
#Locate the template drop-down menu at the top of the screen.   
 
#Locate the template drop-down menu at the top of the screen.   
−
#Select the desired template from the list.
+
#Select the desired template from the list.}}
−
}} }}
+
 
 +
 
 +
{{Top of Page}}
 +
}}

Latest revision as of 17:20, 10 March 2025

Overview

Templates are used to tie searchable and reportable information to videos. When that user starts or schedules a recording their set of templates will automatically get assigned to the associated recording(s).


There are four types of templates:


Templates can be created and customized to meet a wide range of unique applications and workflows. Each template type has a different set of fields that can be used for organizing information. A template can consist of any number of fields and field types.


Each template can have multiple data fields, but at least one field is required. Users can be assigned multiple templates as needed.

🕮Templates are assigned to a user group.

Information Templates

Information templates are used to structure data entered into the system. Users are prompted to complete an information template when they press the Record, Prepare, or Schedule buttons.

VALT 6.3 Manual-Observe 13.png

✎Only admin-level users can create, edit, and assign information templates.


There are a variety of field types available when generating information templates. These field types are used to control and guide users in entering the correct information and associating it with recordings. The available field types include:

  1. Text
  2. Drop Down
  3. Note
  4. Audio
  5. Multi-Select
  6. Image
  7. File
  8. Static Text


⇧ Back to Top

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.

Text

Text fields allow users to enter free-form text into a single-line input box. There is a 255-character limit on a text field, but any characters can be used.

VALT 6.3 Manual-Observe Text.png

Drop Down

Drop-down fields provide users with a predefined list of options, allowing them to select only one item.

VALT 6.3 Manual-Observe Drop Down.png

⚠When names of people are used in a drop-down, they are in no way associated with a users' account.

Note

Notes fields are used when users need a larger space to input more data. The notes field has built-in text wrapping, ensuring users can always see what they have typed. There is no character limit in a notes field.

VALT 6.3 Manual-Observe Note.png

🕮A general note field can be helpful at the end of a template for users to assign more information to a video that does not fit the other categories in the template.

Audio

Audio notes fields allow users to associate audio recordings with the information in a recording. Note that the audio is not indexed or searchable. Audio is recorded using the client PC microphone or headset.

VALT 6.3 Manual-Observe Audio Note.png

To create an audio note:

  1. Click the + 'Add audio' button.
    If not already enabled, your browser may request you Allow Access for microphone usage.
  2. Speak your notes.
  3. When done, click the • 'stop recording' button.

Multi-Select

Multi-Select fields allow users to select multiple options from a predefined list.

VALT 6.3 Manual-Observe Multi-Select.png

⚠When names of people are used in a multi-select, they are in no way associated with a users' account.

Image

Image fields allow users to add a static image to their template. The image will be displayed as part of the information associated with the recording.

VALT 6.3 Manual-Observe Image.png
▶️ Watch our brief video on the Image Field!

File

File fields allow users to upload files to the template. These files will display with a video as an attached file in the information template. Users will be prompted to download the file when trying to access it.

VALT 6.3 Manual-Observe File.png

Allowed file types: .pdf, .xlsx, .xls, .doc, .docx, .rft

Max file size: 100 MB

Max # number of files: 10

Static Text

Static text fields are used to display text that describes a scenario or outlines requirements for how users should fill out the template.

VALT 6.3 Manual-Observe Static.png

✎This text cannot be edited by the user.


⇧ Back to Top

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 template 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 (%).


🕮As of VALT 6.3, you're now able to add more than one evaluation template to a single recording!

▶️ Watch our video about it!



⇧ Back to Top

Evaluation Field Types

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


The four types of fields are:

VALT 6.3 Manual-Observe 15.png


Image

This field allows you to attach images to an evaluation. This can often help provide additional context to your form.

VALT 6.3 Manual-Observe Eval Image.png
▶️ Watch our brief video on the Image Field!

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.

VALT 6.3 Manual-Observe Eval Single-Select.png

Multi-Select

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.

VALT 6.3 Manual-Observe Eval Multi-Select.png

Description

Description fields are larger freeform text boxes. This field is limited to 500 characters and allows the numerical value or score to be entered in the box below.

VALT 6.3 Manual-Observe Eval Description.png

Static Text

Static fields can be used to describe sections of an evaluation.

VALT 6.3 Manual-Observe Eval Static.png


⇧ Back to Top

Comment Templates

Comment templates can be made to structure multiple fields of information when adding a comment. Users can fill out a comment template during live observation or when reviewing a recorded video. A comment template can include multiple data fields but must have at least one.

VALT 6.3 Manual-Observe 14.png


⇧ Back to Top

Comment Field Types


Text

Text fields allow users to enter free-form text into a single-line input box. There is a 255-character limit on a text field, but any characters can be used.

VALT 6.3 Manual-Observe Text.png

Drop Down

Drop-down fields provide users with a predefined list of options, allowing them to select only one item.

VALT 6.3 Manual-Observe Drop Down.png

⚠When names of people are used in a drop-down, they are in no way associated with a users' account.

Note

Notes fields are used when users need a larger space to input more data. The notes field has built-in text wrapping, ensuring users can always see what they have typed. There is no character limit in a notes field.

VALT 6.3 Manual-Observe Note.png

🕮A general note field can be helpful at the end of a template for users to assign more information to a video that does not fit the other categories in the template.

Multi-Select

Multi-Select fields allow users to select multiple options from a predefined list.

VALT 6.3 Manual-Observe Multi-Select.png

⚠When names of people are used in a multi-select, they are in no way associated with a users' account.


⇧ Back to Top

Quick Marker Templates

Quick Markers are used to simplify and standardize the use of frequently referenced markers and comments.

VALT 6.3 Manual-Observe 16.png

Field Types

For marker templates, there is only one field type — Marker.


Marker

The marker field allows you to assign a key word to a colored flag that will be easily found on the timeline in the review section.

VALT 6.3 Manual Templates 00.png

✎Mutiple quick markers can be added to one template.


⇧ Back to Top

Additional Information

Required Fields

When starting a recording, at minimum, the first field must be filled out. Additional fields may also be set as required before starting a recording.


Optional

This field type can be filled out or left blank.

Required

This field type must be completed before the user can start recording, prepare, or schedule.

Pre-filled

This field type contains predefined text but can be modified. If left unchanged, it will automatically populate with the default text.


⇧ Back to Top

Changing Information Templates

If a user group is assigned multiple templates, they can switch between them. To change templates:

  1. Locate the template drop-down menu at the top of the screen.
  2. Select the desired template from the list.


⇧ Back to Top
Retrieved from "https://ipivs.info/wiki/index.php?title=VALT_User_Training_Guide_-_Templates&oldid=14742"