Difference between revisions of "VALT User Training Guide - Templates"
IVSWikiBlue (talk | contribs) m (IVSWikiBlue moved page IVS Wiki:VALT User Training Guide - Information Templates to IVS Wiki:VALT User Training Guide - Templates) |
IVSWikiBlue (talk | contribs) |
||
| Line 1: | Line 1: | ||
{{Article - Manual | content = | {{Article - Manual | content = | ||
<h1>Overview</h1> | <h1>Overview</h1> | ||
| + | |||
| + | <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. Each template can have multiple data fields, but at least one field is [[#Required Fields|required]]. Users can be assigned multiple templates as needed. | 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. | ||
| Line 20: | Line 22: | ||
{{hr}} | {{hr}} | ||
| − | + | {{Manual lvl 2 | title = Field Types Explained | content = }} | |
| − | + | {{Manual lvl 3 | title = Text | content = | |
| − | 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. | + | 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.}} |
{{hr - 2}} | {{hr - 2}} | ||
| − | + | {{Manual lvl 3 | title = Drop-Down | content = | |
Drop-down fields provide users with a predefined list of options, allowing them to select only one item. | 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.}} | + | {{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}} | ||
| − | + | {{Manual lvl 3 | title = Notes | content = | |
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. | 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.}} | + | {{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}} | ||
| − | + | {{Manual lvl 3 | title = Audio Notes | content = | |
| − | 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. | + | 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. |
To create an audio note: | To create an audio note: | ||
| Line 46: | Line 48: | ||
#:<em>If not already enabled, your browser may request you <u>Allow Access</u> for microphone usage.</em> | #:<em>If not already enabled, your browser may request you <u>Allow Access</u> for microphone usage.</em> | ||
#Speak your notes. | #Speak your notes. | ||
| − | #When done, click the {{Add Button 2 | color = #ffab3e | icon = •}} '<strong>stop recording</strong>' button. | + | #When done, click the {{Add Button 2 | color = #ffab3e | icon = •}} '<strong>stop recording</strong>' button.}} |
{{hr - 2}} | {{hr - 2}} | ||
| − | {{Manual lvl | + | {{Manual lvl 3 | title = Multi-Select | content = |
Multi-Select fields allow users to select multiple options from a predefined list. | Multi-Select fields allow users to select multiple options from a predefined list. | ||
{{Aside - Warning | hue = 50 | content = When names of people are used in a multi-select, they are in no way associated with a users' account.}} | {{Aside - Warning | hue = 50 | content = When names of people are used in a multi-select, they are in no way associated with a users' account.}} | ||
| Line 57: | Line 59: | ||
{{hr - 2}} | {{hr - 2}} | ||
| − | + | {{Manual lvl 3 | title = Image | content = | |
| − | 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. | + | 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}} | ||
| − | + | {{Manual lvl 3 | title = File | content = | |
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. | 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. | ||
<br><br> | <br><br> | ||
| Line 70: | Line 72: | ||
*.doc | *.doc | ||
| − | {{Aside | content = The max file size will be listed, when uploading files.}} | + | {{Aside | content = The max file size will be listed, when uploading files.}} }} |
{{hr - 2}} | {{hr - 2}} | ||
| − | + | {{Manual lvl 3 | title = Static Text | content = | |
Static text fields are used to display text that describes a scenario or outlines requirements for how users should fill out the template. | Static text fields are used to display text that describes a scenario or outlines requirements for how users should fill out the template. | ||
| − | {{Aside | content = This text cannot be edited by the user.}} | + | {{Aside | content = This text cannot be edited by the user.}} }} |
{{hr}} | {{hr}} | ||
| − | + | {{Manual lvl 2 | title = Additional Information | content =}} | |
| − | {{Manual lvl | + | {{Manual lvl 3 | 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>must be</u> filled out. Additional fields may also be set as required before starting a recording. | ||
| Line 97: | Line 99: | ||
{{hr - 2}} | {{hr - 2}} | ||
| − | {{Manual lvl | + | {{Manual lvl 3 | title = Changing Information Templates | content = |
If a user group is assigned multiple templates, they can switch between them. To change templates: | If a user group is assigned multiple templates, they can switch between them. To change templates: | ||
#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.}} |
| − | }} }} | + | }} |
Revision as of 09:35, 7 March 2025
Overview
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. Each template can have multiple data fields, but at least one field is required. Users can be assigned multiple templates as needed.
✎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:
Field Types Explained
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.
Drop-Down
Drop-down fields provide users with a predefined list of options, allowing them to select only one item.
⚠When names of people are used in a drop-down, they are in no way associated with a users' account.
Notes
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.
🕮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 Notes
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.
To create an audio note:
- Click the + 'Add audio' button.
- If not already enabled, your browser may request you Allow Access for microphone usage.
- Speak your notes.
- When done, click the • 'stop recording' button.
Multi-Select
Multi-Select fields allow users to select multiple options from a predefined list.
⚠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.
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.
Allowed file types will be listed within your VALT system. Some of the allowed file types include (but are not limited to):
- .xlsx
- .doc
✎The max file size will be listed, when uploading files.
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.
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.
Changing Information Templates
If a user group is assigned multiple templates, they can switch between them. To change templates:
- Locate the template drop-down menu at the top of the screen.
- Select the desired template from the list.
