Difference between revisions of "IVS Wiki:VALT CUE"

From IVS Wiki
Jump to: navigation, search
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Article - Manual | content =  
 
{{Article - Manual | content =  
−
<h1>VALT CUE Installation</h1>
+
<h1>Introduction</h1>
−
{{Manual lvl 2 | title = Add CUE device in VALT | content =  
+
VALT Cue is an app that walks you through a timed recording session with on screen prompts and audio/visual cues. Cue uses your VALT system’s rooms, information templates, and assessments to create session structure that is familiar and consistent.
 +
 
 +
{{hr}}
 +
 
 +
<h1>VALT Cue Installation</h1>
 +
 
 +
{{Manual lvl 2 | title = Add Cue device in VALT | content =  
 
<ol>
 
<ol>
−
<li>The first step to implementing VALT CUE with your instance of VALT is setting up the device in the <b>Settings</b> page of VALT.</li>  
+
<li>The first step to implementing VALT Cue with your instance of VALT is setting up the device in the <b>Settings</b> page of VALT.</li>  
−
<li>Navigate to the <b>Rooms & Devices</b> subsection and click the plus icon in the top right corner to <b>Add CUE device</b>. </li>  
+
{{hr - 2}}
−
 
+
<li>Navigate to the <b>Rooms & Devices</b> subsection and click the plus icon in the top right corner to <b>Add Cue device</b>. </li>  
−
{{Aside | content = You will need an additional device license for each VALT CUE device.}}
 
  
 +
{{Aside | content = You will need an additional device license for each VALT Cue device.}}
 +
{{hr - 2}}
 
<li>Input the appropriate Name, Media Server, and Device Type, and leave the Rooms field blank. </li>  
 
<li>Input the appropriate Name, Media Server, and Device Type, and leave the Rooms field blank. </li>  
 +
{{hr - 2}}
 
<li>Hit the save button.</li>  
 
<li>Hit the save button.</li>  
  
Line 14: Line 22:
 
</ol>}}
 
</ol>}}
  
−
{{Manual lvl 2 | title = Installing VALT CUE | content = Navigate to the App Store on the device. Search for <b>IVS Cue</b> and install the app.}}
+
 
−
{{Manual lvl 2 | title = Connecting VALT CUE to VALT | content = When you open the IVS Cue app, you will be prompted to <b>Connect to a server</b>. You will need to fill out the following values:
+
{{Top of Page}}
−
<table class="simple_table">
+
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Installing VALT Cue | content = Navigate to the App Store on the device. Search for <b>IVS Cue</b> and install the app.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Connecting VALT Cue to VALT | content = When you open the IVS Cue app, you will be prompted to <b>Connect to a server</b>. You will need to fill out the following values:
 +
<table class="wikitable">
 
     <tr>
 
     <tr>
−
         <td style="width: 150px;">Server Address</td>
+
         <th style="width: 150px;">Server Address</th>
 
         <td>Enter the IP address or FQDN of the server. It must be entered as http://<ipaddress> or https://<fqdn> if you are using SSL.</td>
 
         <td>Enter the IP address or FQDN of the server. It must be entered as http://<ipaddress> or https://<fqdn> if you are using SSL.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Device UID</td>
+
         <th>Device UID</th>
 
         <td>You can obtain this by pulling up the iPad device on the VALT application's Settings page.</td>
 
         <td>You can obtain this by pulling up the iPad device on the VALT application's Settings page.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Username</td>
+
         <th>Username</th>
−
         <td rowspan="2">This must be a user with administrator rights.</td>
+
         <td rowspan="2">This must be a user in the admin group.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Password</td>
+
         <th>Password</th>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 36: Line 53:
  
  
−
<h1>VALT CUE Configuration</h1>
+
{{Top of Page}}
−
{{Manual lvl 2 | title = Step 2: Track Setup | content = }}
+
{{hr}}
−
{{Manual lvl 2 | title = Session Setup | content = }}
+
 
−
{{Manual lvl 3 | title = Step 3: Room | content = }}
+
<h1>VALT Cue Configuration</h1>
−
{{Manual lvl 3 | title = Step 4: Information | content = }}
+
{{Manual lvl 2 | title = Track Setup | content = Once you have synced the device to the VALT system, you will be taken to the Session track setup page.
−
{{Manual lvl 3 | title = Step 5: Evaluation template | content = }}
+
*To <b>Rename</b> the current track, tap on the pencil icon and type in the new track name.
 +
*To upload any file to be associated with the track, utilize the <b>Upload</b> button.
 +
*To download the current track setup, tap the <b>Download</b> button.
 +
*To make the current track looping, toggle the <b>Loop</b> switch.
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Session Setup | content = To add a session to the current track, press the <b>Create session</b> button. You will be taken through the following three steps as many times as needed to add all of your sessions to the track:}}
 +
 
 +
 
 +
{{Manual lvl 3 | title = Room | content = On the <b>Room</b> step, you will be asked to fill out the following fields:
 +
*<b>Session name</b>: The session name will serve as the title for this recording within VALT.
 +
*<b>Repetition number</b>: Input the number of times this session will repeat before moving to the next session.
 +
*<b>Room</b>: Select the Room that this session will take place in from the drop down.
 +
 
 +
Select <b>Next</b> to continue on to the Information section. <br>
 +
Select <b>Cancel</b> to discard the information and return to the Session track page.
 +
}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Information | content = On the <b>Information</b> step, you will be asked to select which information template to use for the session and to define the fields that will be visible to the user starting the recording on Cue. <br>
 +
*Template: Select which <b>Template</b> to use from the drop down.
 +
{{Aside - Helpful | content = Learn more about <b>templates</b> [[VALT_Manual_-_Templates|here]].}}
 +
*Fields: Select which <b>Fields</b> will be accessible from the Cue app from the drop down. <br>
 +
*Notifications: To configure notifications during the session, tap <b>Add notification</b>. You may add as many notifications as needed, although they cannot overlap with each other.
 +
*For each notification, you will need to set the following:
 +
**Notification color
 +
**Time to send the notification
 +
**Notification sound
 +
**To remove a notification, tap the trash can icon to the right.
 +
Select <b>Next</b> to continue on to the Evaluation step
 +
}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Evaluation template | content = On the <b>Evaluation template</b> step, you will select the evaluation template to be used with this recording, as well as defining any fields that the user should fill out within Cue. <br>
 +
Hit the <b>Save Session</b> button to return to the Session track screen.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Finish Setup | content = Once you have added all of the sessions to your track, tap the Finish button on the bottom right, which will take you to the end user login page.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
<h1>Using VALT Cue</h1>
 +
{{Manual lvl 2 | title = Login Page | content = The end user should be presented the Cue device on the Login in page. The Room, Session Name, and Session Duration will be displayed above the login.
 +
*To Login, input the <b>username</b> and <b>PIN code</b> associated with your user account, and tap <b>Log in</b>.
 +
*Select the <b>Remember me</b> option to use the same login for the entire track.
 +
}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Fill Out Information | content = The user will be taken to the Information template of the recording, seeing only the previously defined fields from that template. Fill out any outstanding fields, then press <b>Continue</b> to move on to the timer.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Timer | content = On the Timer page, the timer will count down for the appointed duration. Notifications will go off at the appointed times, with the accompanying visual cue. Once the timer reaches 0 seconds, press <b>Continue</b> to move on the Evaluation phase.}}
 +
 
 +
 
 +
{{Top of Page}}
 +
{{hr}}
 +
 
 +
{{Manual lvl 2 | title = Evaluation | content = The user will be taken to the Evaluation template associated with the recording, seeing only the previously defined fields from that template. Fill out any outstanding fields, then press <b>Finish</b> to complete the current session and return to the Log in page. If you previously checked <b>Remember me</b>, your credentials will auto-populate. Otherwise, enter your credentials to begin the next session. When all sessions are complete, you will be returned to the configuration page.}} 
 +
 
  
−
<h1>Using VALT CUE Live</h1>
+
{{Top of Page}}
 
}}
 
}}

Latest revision as of 13:24, 9 April 2025

Introduction

VALT Cue is an app that walks you through a timed recording session with on screen prompts and audio/visual cues. Cue uses your VALT system’s rooms, information templates, and assessments to create session structure that is familiar and consistent.

VALT Cue Installation

Add Cue device in VALT

  1. The first step to implementing VALT Cue with your instance of VALT is setting up the device in the Settings page of VALT.
  2. Navigate to the Rooms & Devices subsection and click the plus icon in the top right corner to Add Cue device.

    3. ✎You will need an additional device license for each VALT Cue device.

  3. Input the appropriate Name, Media Server, and Device Type, and leave the Rooms field blank.
  4. Hit the save button.

    5. ✎Be sure to navigate back to that device to take note of the Device UID, as this value will be used to connect the device to VALT later on.


⇧ Back to Top

Installing VALT Cue

Navigate to the App Store on the device. Search for IVS Cue and install the app.


⇧ Back to Top

Connecting VALT Cue to VALT

When you open the IVS Cue app, you will be prompted to Connect to a server. You will need to fill out the following values:

Server Address Enter the IP address or FQDN of the server. It must be entered as http://<ipaddress> or https://<fqdn> if you are using SSL.
Device UID You can obtain this by pulling up the iPad device on the VALT application's Settings page.
Username This must be a user in the admin group.
Password


⇧ Back to Top

VALT Cue Configuration

Track Setup

Once you have synced the device to the VALT system, you will be taken to the Session track setup page.

  • To Rename the current track, tap on the pencil icon and type in the new track name.
  • To upload any file to be associated with the track, utilize the Upload button.
  • To download the current track setup, tap the Download button.
  • To make the current track looping, toggle the Loop switch.


⇧ Back to Top

Session Setup

To add a session to the current track, press the Create session button. You will be taken through the following three steps as many times as needed to add all of your sessions to the track:


Room

On the Room step, you will be asked to fill out the following fields:

  • Session name: The session name will serve as the title for this recording within VALT.
  • Repetition number: Input the number of times this session will repeat before moving to the next session.
  • Room: Select the Room that this session will take place in from the drop down.

Select Next to continue on to the Information section.
Select Cancel to discard the information and return to the Session track page.

Information

On the Information step, you will be asked to select which information template to use for the session and to define the fields that will be visible to the user starting the recording on Cue.

  • Template: Select which Template to use from the drop down.

🕮Learn more about templates here.

  • Fields: Select which Fields will be accessible from the Cue app from the drop down.
  • Notifications: To configure notifications during the session, tap Add notification. You may add as many notifications as needed, although they cannot overlap with each other.
  • For each notification, you will need to set the following:
    • Notification color
    • Time to send the notification
    • Notification sound
    • To remove a notification, tap the trash can icon to the right.

Select Next to continue on to the Evaluation step

Evaluation template

On the Evaluation template step, you will select the evaluation template to be used with this recording, as well as defining any fields that the user should fill out within Cue.
Hit the Save Session button to return to the Session track screen.


⇧ Back to Top

Finish Setup

Once you have added all of the sessions to your track, tap the Finish button on the bottom right, which will take you to the end user login page.


⇧ Back to Top

Using VALT Cue

Login Page

The end user should be presented the Cue device on the Login in page. The Room, Session Name, and Session Duration will be displayed above the login.

  • To Login, input the username and PIN code associated with your user account, and tap Log in.
  • Select the Remember me option to use the same login for the entire track.


⇧ Back to Top

Fill Out Information

The user will be taken to the Information template of the recording, seeing only the previously defined fields from that template. Fill out any outstanding fields, then press Continue to move on to the timer.


⇧ Back to Top

Timer

On the Timer page, the timer will count down for the appointed duration. Notifications will go off at the appointed times, with the accompanying visual cue. Once the timer reaches 0 seconds, press Continue to move on the Evaluation phase.


⇧ Back to Top

Evaluation

The user will be taken to the Evaluation template associated with the recording, seeing only the previously defined fields from that template. Fill out any outstanding fields, then press Finish to complete the current session and return to the Log in page. If you previously checked Remember me, your credentials will auto-populate. Otherwise, enter your credentials to begin the next session. When all sessions are complete, you will be returned to the configuration page.


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