Difference between revisions of "Docs/Settings"

From Userful Support
Jump to: navigation, search
(Additional Packages and Software)
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Public Support Wiki}}
 
{{Public Support Wiki}}
 
{{DISPLAYTITLE:
 
{{DISPLAYTITLE:
Control Center: System Operations
+
Control Center: Settings
 
}}
 
}}
{{CopyrightNotice|{{REVISIONYEAR}}}}
+
{{CopyrightNotice|{{CURRENTYEAR}}}}
  
 
{{DocsMainReturn}}
 
{{DocsMainReturn}}
 
<br>
 
<br>
 
== Introduction ==
 
== Introduction ==
This section of the Control Center consist of the functions that affects the entire system that is the Userful host and all connected stations. These functions include:
+
This section of the Control Center consists of the functions that affect the entire system including the Userful server and all the connected displays. These functions include:
  
* Failover Settings
+
* Manage System License
* Managing Licenses
+
* Change Admin Password
* Changing Admin Password
+
* Failover Group Settings
* Creating Staff User
+
* Remote Control Settings
* Changing Hostname
+
* Performance Settings
* Enabling Nvidia Support
+
* Broadcast Alert
 +
* Receiver Device Configuration
 +
* Screen Capture Configuration
 +
* USB Storage Settings
 +
* Shared Files Settings
 +
* Source Content Settings
 +
* Create Staff User
 +
* Change root password
 +
* Change Hostname
 
* Power Management
 
* Power Management
* Reboot / Shut down the system
+
* Reboot / Shutdown the system
 
* Network Settings
 
* Network Settings
* Managing Updates
+
* Manage Updates
* Changing System Date, Time and Language
+
* Manage System Date, Time and Language
  
=== Failover Group Settings===
+
===General===
Failover eliminates the risk of single point of failure. It requires at least two Userful hosts in the same subnet. In the event of failure backup host can take over the stations that were assigned to the failed host. Please refer to [[Docs/Failover |Failover]] page for detailed information.
+
The settings listed under General category allow users to access some of the key features of Userful&trade; such as Licensing, Failover Settings, Remote Control Settings etc.
  
=== Manage Licensing ===
+
==== Manage Licensing ====
With Userful™, Licensing is quick and easily managed through the Control Center. The unlicensed version of Userful™ is fully functional, but will display a brief registration reminder on all attached displays every 20 minutes or so. To enable the full version, you need a valid license for each display.
+
With Userful™, Licensing is quickly and easily managed through the Control Center. The unlicensed version of Userful™ is fully functional but will display a brief registration reminder on all attached displays every 20 minutes or so. To enable the full version, you need a valid license for each display.
 
<br>
 
<br>
====Getting License Key Online ====
+
=====Getting License Key Online =====
 
[[Image:UCC_Replace_License1.png|right|400px|thumb| Manually Install License]]
 
[[Image:UCC_Replace_License1.png|right|400px|thumb| Manually Install License]]
To get your Userful host licensed online, goto "Manage Licensing" link under System Operations.
+
To get your Userful host licensed online, Go to "Manage Licensing" link under Settings.
  
 
'''If you already have  an activation code:'''
 
'''If you already have  an activation code:'''
 
<ol>
 
<ol>
 
<li>Enter the Activation Code in the first box.
 
<li>Enter the Activation Code in the first box.
<li> Enter the maximum number of stations to be used in the second box.
+
<li> Enter the maximum number of displays to be used in the second box.
 
<li>Press "Download and Install License" button to get the license key.
 
<li>Press "Download and Install License" button to get the license key.
 
</ol>
 
</ol>
  
'''Note:''' The activation code is tied to a certain number of stations. The number of stations entered cannot exceed the number specified when activation code was created.  
+
'''Note:''' The activation code is tied to a certain number of displays. The number of displays entered cannot exceed the number specified when the activation code was created.  
 
<br><br>
 
<br><br>
 
'''To get the "Activation Code", click "Get Activation Code" and submit the form.'''
 
'''To get the "Activation Code", click "Get Activation Code" and submit the form.'''
Line 46: Line 54:
 
|
 
|
  
'''You will need an active Internet connection to automatically install the license key or to submit the request for activation code.'''
+
'''You will need an active Internet connection to automatically install the license key or to submit the request for an activation code.'''
  
Your web browser submits the basic system information to the license server as a part of the activation process. This information includes MAC address, Userful™ version and other hardware information.  
+
Your web browser submits the basic system information to the license server as a part of the activation process. This information includes MAC address, Userful™ version, and other hardware information.  
  
 
The license key file(s) are installed automatically and take effect without rebooting the system.
 
The license key file(s) are installed automatically and take effect without rebooting the system.
Line 54: Line 62:
 
<br clear="all" /br>
 
<br clear="all" /br>
  
====Installing a License Key from a File====
+
=====Installing a License Key from a File=====
 
[[Image:UCC_Manual_Install_License.png|right|400px|thumb | Install License Key]]
 
[[Image:UCC_Manual_Install_License.png|right|400px|thumb | Install License Key]]
A Internet connection is required to use the activation code to install your license. If there is no Internet connection, email the MAC address or System ID of the Userful host you need to license along with your activation code to the Userful representative. They will generate a license key and send it to you as an attachment.
+
An Internet connection is required to use the activation code to install your license. If there is no Internet connection, email the MAC address or System ID of the Userful host you need to license along with your activation code to the Userful representative. They will generate a license key and send it to you as an attachment.
  
 
To install a license key from a file:
 
To install a license key from a file:
 
# Copy the file to the desktop of the system to be licensed or mount a USB flash drive containing the license key file.
 
# Copy the file to the desktop of the system to be licensed or mount a USB flash drive containing the license key file.
# From the starting screen of the Licensing section, click on the button marked "Manually Install License File" under <tt> System Operations > Manage Licensing > Replace License</tt>.
+
# From the starting screen of the Licensing section, click on the button marked "Manually Install License File" under <tt> Settings > Manage Licensing > Replace License </tt>
 
# Click on the "Browse" button and navigate through the file system to the directory where the license key is saved. Select the license key file and choose "Open".
 
# Click on the "Browse" button and navigate through the file system to the directory where the license key is saved. Select the license key file and choose "Open".
 
# Click on the "Upload License File" button. The license key file is installed automatically and takes effect after rebooting the system.
 
# Click on the "Upload License File" button. The license key file is installed automatically and takes effect after rebooting the system.
 +
<br clear="all"/>
  
==== Increasing the Maximum Number of Stations on a License ====
+
===== Increase Licensed Displays=====
[[Image:UCC_Increase_Stations.png|right|400px|thumb| Increase Number of Stations]]
+
[[Image:UCC_Increase_Stations.png|right|400px|thumb| Increase Number of Displays]]
If your contract allows, it is possible to increase the maximum number of stations connected to a given Userful host without replacing the license.  
+
If your contract allows, it is possible to increase the maximum number of displays connected to a given Userful host without replacing the license.  
To do this, click on the "Increase Stations" link under <tt> System Operations > Manage Licensing </tt>
+
To do this, click on the "Increase Displays" link under <tt> Settings > Manage Licensing </tt>
  
 
If desired, backup the existing license by clicking the "Backup your current license file” link in the dialogue that appears.  
 
If desired, backup the existing license by clicking the "Backup your current license file” link in the dialogue that appears.  
  
Enter the “Activation Code” and the new "Maximum Number of Stations". Click on the "Request Increase from License Server" button to complete the operation. <br><br>
+
Enter the “Activation Code” and the new "Maximum Number of Displays". Click on the "Request Increase from License Server" button to complete the operation.  
''' Please Note: The new maximum number of stations entered must be greater than the current maximum. '''
+
''' Please Note: The new maximum number of displays entered must be greater than the current maximum. '''
 
<br><br>
 
<br><br>
The "License Details" will now reflect the increased Maximum Number of Stations.
+
The "License Details" will now reflect the increased Maximum Number of Displays.
 
<br clear="all"/>
 
<br clear="all"/>
  
==== Backing up a License File ====
+
===== Backing up a License File =====
* To back up a license file, go to <tt> System Operations > Manage Licensing</tt> and click the "Download/Backup current license".
+
* To back up a license file, go to <tt> Settings > Manage Licensing</tt> and click the "Download/Backup current license".
 
** This will open a dialogue box asking to confirm the file-saving operation. Click "Save" to save a copy of the license file with a ".bak" file extension in the /etc/userful/license/ directory.
 
** This will open a dialogue box asking to confirm the file-saving operation. Click "Save" to save a copy of the license file with a ".bak" file extension in the /etc/userful/license/ directory.
  
==== Replacing an Existing License ====
+
===== Replacing an Existing License =====
Sometimes it may be necessary to replace a license on a working system; for example, to add more stations to the license. Contact your Userful representative if you have any questions about obtaining a replacement license.<br>  
+
Sometimes it may be necessary to replace a license on a working system; for example, to add more displays to the license. Contact your Userful representative if you have any questions about obtaining a replacement license.<br>  
To replace a license, go to <tt> System Operations > Manage Licensing </tt> and click the "Replace License" button.  
+
To replace a license, go to <tt> Settings > Manage Licensing </tt> and click the "Replace License" button.  
 
Follow the instructions to either get a license through the Internet (if you have an activation code) or install a license file manually.
 
Follow the instructions to either get a license through the Internet (if you have an activation code) or install a license file manually.
 
<br>
 
<br>
 
<br>
 
<br>
  
'''Note:''' License persist when product is upgraded to a newer version. That is, if you already have a license for a version of Userful™, you can update your system to the newest available version without obtaining a new license as long as you have an active maintenance and support contract.'''
+
'''Note:''' License persist when the product is upgraded to a newer version. That is, if you already have a license for a version of Userful™, you can update your system to the newest available version without obtaining a new license as long as you have an active maintenance and support contract.'''
 +
<br>
  
  
 +
==== Change Server Name ====
 +
[[File:Change_Hostname.png|right|thumb| Change Server Name| 400px]]
 +
User can change <tt>Server Name</tt> using this link.
 +
* Click on <tt> Control Center > Settings > Change Server Name</tt> link
 +
* A window will popup, enter New Server Name
 +
* Click "OK" to complete the process
 
<br>
 
<br>
 +
'''This will restart all connected receiver devices and Control Center will be blocked until all the receiver devices come back online and the server name is changed successfully.'''
 +
<br clear="all"/>
 +
 +
==== Failover Group Settings ====
 +
Failover eliminates the risk of single point of failure. It requires at least two Userful servers in the same subnet. In the event of failure, secondary server can take over the displays that were assigned to the primary server. Please refer to [[Docs/Failover |Failover]] page for detailed information.
 +
 +
 +
====Remote Control Settings====
 +
Userful&trade; software appliance lists down various [[Docs/Remote_Control_Settings|Remote Control Settings]] that user can enable or use to remotely control and interact with stand-alone displays and video walls. These settings include features like Source Switcher, Preset Switcher, and Interactive Viewer.
 +
 +
{|{{Notes}}
 +
|'''Note:''' Appropriate license tier or Advanced Subscription is required to access these features, please contact your Sales Representative or send an email to [mailto:sales@userful.com  sales@userful.com] for more details.
 +
|}
 +
 +
 +
[[File:Remote_Control_Settings.png|right|thumb| Remote Control Settings| 400px]]
 +
=====Source Switcher=====
 +
Source Switcher is available under all license tiers '''except''' ''Basic''. It allows users to launch and switch source on displays and video walls using a single-click, it can be accessed from any web browser within the same network, using any device including smartphones and tablets. For more information, visit [[Docs/Source_Switcher | Source Switcher]].
 +
 +
=====Preset Switcher=====
 +
Preset Switcher is available only under [[Docs/Licensing#Ultimate |"Ultimate"]] license or "Advanced Subscription". It allows users to launch and switch between the saved preset (i.e., display mapping configuration) using a single-click, it can be accessed from any web browser within the same network, using any device including smartphones and tablets. For more information, visit [[Docs/Preset_Switcher | Preset Switcher]] .
 +
 +
===== Interactive Viewer =====
 +
Interactive Viewer is available only under [[Docs/Licensing#Ultimate |"Ultimate"]] license or "Advanced Subscription". It allows users to remotely interact with standalone displays or video walls playing Interactive sources (e.g., Web Browser, Linux Desktop, Cloud Desktop etc.), via keyboard and mouse of a different computer such as Userful host, connected display or any device in the same local area network. For more information on how to use this feature, visit [[Docs/Interactive_Viewer| Interactive viewer]]. <br>
 +
<br clear="all"/>
 +
 +
====Performance Settings====
 +
[[File:Performance_Settings.png|right|thumb| Performance Settings| 400px]]
 +
Userful&trade; software appliance lists down system-level settings that user can use or enable for optimal performance and content synchronization. These settings include features like Nvidia Offload Support, Intel Offload Support, Direct Sync and Display Scaling. For more information, visit [[Docs/Performance Settings|Performance Settings]].
 +
<br clear="all" br/>
 +
 +
====Broadcast Alert====
 +
[[File:Broadcast_Alert.png|right|thumb| Broadcast Alerts| 400px]]
 +
Broadcast Alert allows the administrator to send short messages or alerts across online displays. To send message/alert across displays :
 +
* From the "Control Center" Navigation Panel, go to Settings
 +
* Enter the message in the text area provided.
 +
* Select "Alert level"
 +
* Select Display Length/Time Duration for a message from the drop-down (e,g. display a message for 2 minutes)
 +
* Click "Start Broadcast" button
 +
 +
The message will be displayed on all online displays including the Userful host. Admin can cancel a message broadcast by simply clicking the "Stop Broadcast" button.
 +
 +
<br clear="all">
 +
 +
====Receiver Device Configuration====
 +
[[File:Zero_Client_Configuration.png|right|thumb| Zero-Client Configuration| 400px]]
 +
Receiver Device Configuration specifies how new receiver devices are assigned to the Userful server (i.e., automatic or manual). Select one of the following options:
 +
* Automatically assign new receiver devices to this Userful server, or
 +
* Manually assign new receiver devices to this Userful server
 +
 +
By default, administrators have to manually assign receiver devices to the Userful server. To assign receiver devices, please visit  [[Docs/Managing_Displays#Assigning_and_Releasing_Displays |Managing Displays]].
 +
<br clear="all">
 +
 +
{{:Docs/Screen_Capture}}
 +
 +
 +
===Storage Management===
 +
Storage Settings allow users to transfer and access files across displays. It enables users to configure various settings and optional password protection feature to access "shared-files" folder.
 +
 +
====USB Storage Settings====
 +
[[File:USB_Storage.png|right|thumb|USB Storage Settings| 400px]]
 +
This option allows users to mount USB storage devices from certain interactive sources like Linux Desktop and Cloud Desktop. To allow access to USB storage devices:
 +
* Enable access to USB storage
 +
* Click OK to complete the process
 +
 +
'''Note:''' USBs cannot be mounted by default, as the initial setting of "Enable access to USB storage" is Off.
 +
<br clear="all" br/>
 +
 +
====Shared Files Settings====
 +
[[File:Desktop_Shared_Files_Settings.png|right|thumb|Desktop Shared Files Settings | 400px]]
 +
=====Desktop Shortcut=====
 +
This option enables easy access to "shared-files" folder on the native desktops. (i.e., Cloud Desktop and Linux Desktop)
 +
 +
=====Auto Cleanup=====
 +
This option enables deletion of the unused files under "shared-files" folder that have not been accessed within the specified number of days.
 +
<br clear="all" br/>
 +
 +
====Source Content Settings====
 +
[[File:Source_Content_Settings.png|right|thumb|Source Content Settings | 400px]]
 +
=====Browser Access=====
 +
This option provides '''read-only''' access to source content from the Web Browser. Users can see the list of files by typing <code>http://localhost:81</code> or <code>http://[Userful server IP Address]:81</code> in the browser’s address bar.
 +
 +
=====FTP and Network Share Access=====
 +
This option enables password protection feature for FTP Server Access and Network Share Access. If enabled, users will need to use "files" as username along with the specified password.
 +
 +
=====Network Share Access=====
 +
This option provides access across the network, e.g.:
 +
* Windows users can access the folder by typing <code>\\[Userful server IP Address]</code> in a browser.
 +
* Mac users can access shared-files folder from <code>Finder > Go > Connect to Server</code>
 +
 +
=====FTP Server Access=====
 +
This option allows users to access the source-content folder using a FTP client.
 +
 +
<br clear="all" br/>
 +
 +
===User Management===
 +
The settings listed under User management allow users to change the root password, create staff user, change staff password to maintain the proper authentication process
  
===Set Root Password===
+
====Change root Password====
 +
[[File:Change_root_Password.png|400px|right|thumb|Change root Password]]
 
Userful&trade; software appliance does not set the '''root''' password by default. Root access is only necessary for non-graphical troubleshooting and advanced integration.  
 
Userful&trade; software appliance does not set the '''root''' password by default. Root access is only necessary for non-graphical troubleshooting and advanced integration.  
 
User can set and change '''root''' password using this link. To do so:
 
User can set and change '''root''' password using this link. To do so:
  
* From the "Control Center" Navigation Panel, go to System Operations
+
* From the "Control Center" Navigation Panel, go to Settings
* Click on the "Set Root Password" link
+
* Click on the "Change root Password" link
* A window will pop with an advise not to set the root password as this will limit the level of support from Userful team
+
* A window will pop with an advise not to set the root password as this will limit the level of support from the Userful team
 
* Click OK to continue
 
* Click OK to continue
* A window will popup, enter New Password and Repeat Password
+
* A window will pop up, enter New Password and Repeat Password
 
* Click "OK" to complete the process  
 
* Click "OK" to complete the process  
  
'''The change will take effect immediately without system reboot.'''
+
'''The change will take effect immediately without the system reboot.'''
  
===Change user Password===
+
====Change user Password====
 
[[File:Change_User_Password.png|400px|right|thumb|Change User Password]]
 
[[File:Change_User_Password.png|400px|right|thumb|Change User Password]]
To change the user account password set during "Initial Setup" process, click "Change user Password" link  
+
To change the user account password set during the "Initial Setup" process, click "Change user Password" link  
* A window will popup, enter the current password, new password and repeat password in the respective fields
+
* A window will pop up, enter the current password, new password and repeat password in the respective fields
 
* Click "OK" to complete the process
 
* Click "OK" to complete the process
  
Line 115: Line 229:
 
<br clear="all"/>
 
<br clear="all"/>
  
===Create staff user===
+
====Create staff User====
 
[[Image:Create_Staff_User.png|right|thumb|400px |Create Staff User]]
 
[[Image:Create_Staff_User.png|right|thumb|400px |Create Staff User]]
 
With the release of Userful 8.6, Userful provides the ability to create "staff" user account for limited access functionality. A staff user will have limited privileges as compared to an "admin" user (user account created during the Initial Setup) and can access following Control Center features:
 
With the release of Userful 8.6, Userful provides the ability to create "staff" user account for limited access functionality. A staff user will have limited privileges as compared to an "admin" user (user account created during the Initial Setup) and can access following Control Center features:
  
 
* Play and pause video playback
 
* Play and pause video playback
* Remap displays and video walls to existing session containers
+
* Interact with video walls via Interactive Viewer functionality
 +
* Remap displays and video walls to existing sources
 
* Create Mirror groups
 
* Create Mirror groups
 
* Reboot / Shutdown the Userful host
 
* Reboot / Shutdown the Userful host
 
* Reset zero client devices
 
* Reset zero client devices
 
* Broadcast alert messages
 
* Broadcast alert messages
* Browser remote
 
 
* Contact Support and access to support portal
 
* Contact Support and access to support portal
  
 
To create and edit the '''staff''' user account:
 
To create and edit the '''staff''' user account:
* Open Control Center > System Operations and click "Create staff user"  
+
* Open Control Center > Settings and click "Create staff user"  
 
* Enter the data in the "New Password" and "Repeat Password" fields
 
* Enter the data in the "New Password" and "Repeat Password" fields
 
* Click OK to complete the process
 
* Click OK to complete the process
 
Once completed, log out of the Control Center. On the login screen "staff" user is listed under the available username drop-down.
 
Once completed, log out of the Control Center. On the login screen "staff" user is listed under the available username drop-down.
  
=== Change Hostname ===
+
===Power Management===
[[File:UCC_Change_Hostname.png|right|thumb| Change Hostname| 400px]]
+
The settings listed under this category allow users to conserve power and improve the stability of the system
User can change <tt>Hostname</tt> using this link.
+
 
* Click on <tt> Control Center > System Operations > Change Hostname</tt> link
+
==== Automatic Nightly Shutdown / Reboot (Server) ====
* A window will popup, enter New Hostname
+
[[File:Auto_Nightly_Shutdown.png|thumb|Automatic Nightly Shutdown|600px]]
* Click "OK" to complete the process
+
 
 +
To conserve power and to ensure proper shutdown or reboot of the Userful server, you can enable automatic shutdown/reboot process. To enable this:
 +
# Click "Auto Nightly Shutdown / Reboot (Server)" link  
 +
# Enable the checkbox and choose between the toggle button '''Shutdown''' or '''Reboot''' the Userful server
 +
# Enter the time in (HH/MM) format
 +
 
 +
Note: Warning message will pop 5 minutes before the scheduled time to notify all users to save their work. <br>
 
<br>
 
<br>
'''This change will restart all connected zero cients and the Control Center, the change will take effect after system reboot.'''
+
Control Center also provides instructions to do automatic power-on using BIOS. This feature is particularly helpful if it is hard to access Userful server physically. Click on the "[[Docs/How_To_Schedule_Power_On | change BIOS settings]]" link and follow the instructions.
 
<br clear="all"/>
 
<br clear="all"/>
  
===Nvidia Offload Card===
+
====Power Management (Display)====
[[File:Nvidia_offload_card.png|thumb|Nvidia Offload Support|383px]]
+
[[File:Power_Management.png|400px|right|thumb| Power Management]]
Userful™ supports Nvidia GPU offloading that enables you to create a high quality video wall with better content synchronization. For more details, visit [[Docs/Nvidia_Offload_Support | Nvidia Support]] page.
+
Userful™ software provides an option to save power for receiver devices. It can also be used to maximize the useful life of display devices including projectors. To enable power management for displays:
<br clear="all"/>
+
* Open <tt>Control Center > Settings > Power Management (Display)</tt>.
 +
* Enable the options available as per the requirement:
 +
:* Show screen saver after the specified time
 +
::* Enter the screen saver directory
 +
::* Enter the screen saver interval(s)
 +
:* Power off displays on inactive display after the specified time
 +
:* Power off all displays between the specified time period
 +
* Click "OK" to complete the process
  
===Display Scaling===
+
All connected displays including the host display will go offline as per the option selected.<br>
[[File:Display_Scaling.png|400px|right|thumb|Display Scaling]]
+
By default the Userful host is configured to use display scaling that uses the built-in scaler within the display to improve the image quality. Almost all displays have a built-in scaler that converts incoming sources to fit their output display size. You can switch to "server-side" scaling by disabling the option as show in the image to the right.
+
  
:'''Note:''' Switching to server side scaling may improve image quality but increases network bandwidth.
+
'''Note:''' Screensaver can only be activated on certain sources (e.g., Welcome Screen, Cloud Desktop etc.)
  
 
<br clear="all"/>
 
<br clear="all"/>
  
===Enable Browser Remote===
+
==== Reboot and Shut Down System ====  
Browser Remote feature allows user to launch sessions from any browser using any device. For more information about using this feature, visit [[Docs/Browser_Remote | Browser Remote]] page.
+
Userful server can be reboot or shut down using the "Reboot System" and "Shut Down System" links respectively. <br>
 +
Clicking on each button will bring up a confirmation dialog and once confirmed appropriate action will be performed.
 +
<br>
  
===Power Management===
+
===System Updates and Extra Packages===
==== Automatic Nightly Shutdown ====
+
Userful team is continually working to improve product stability and feature set for upcoming version releases. Occasionally, Userful may release important updates between official software version releases. <br>
[[File:UCC_Power_Mgmt.png|thumb|Automatic Nightly Shutdown|400px]]
+
  
To conserve power and to ensure proper shutdown of the Userful host, you can enable automatic shutdown process. To enable this:
+
{|{{Notes}}
# Click "Automatic Nightly Shutdown (Host)" and check the "Automatically Shutdown the host PC/server" checkbox
+
|'''Note:''' An active Internet connection and a valid ''Maintenance and Support'' contract is required to access the software updates. Please contact your Sales Representative or send an email to [mailto:sales@userful.com  sales@userful.com] for more details.
# Enter the time in (HH/MM) format
+
|}
  
Note: Warning message will pop 5 minutes before the scheduled time to notify all users to save their work. <br>
+
====Check for System Updates====
<br>
+
Control Center also provides instructions to do automatic power-on using BIOS. This feature is particularly helpful if it is hard to access host PC/server physically. Click on the "[[Docs/How_To_Schedule_Power_On | change BIOS settings]]" link and follow the instructions.
+
<br clear="all"/>
+
  
====DPMS Settings====
+
The best way to install Userful and other system updates is through <tt>Control Center > Settings </tt>  
[[File:DPMS_Settings.png|400px|right|thumb| Power Management]]
+
* Click the "Check for System Updates" link
Userful&trade; software appliance provides DPMS (Display Power Management Signaling) support for network zero client devices. DPMS is a standard used to save power and maximize the useful life of display devices including projectors. To enable DPMS functionality for displays:
+
* Select option as per your maintenance contract and click "Continue" and follow the update prompts.
* Open <tt>Control Center > System Operations > Power Management (Display)</tt>.
+
* Reboot the system after update.
* Check one of the options available as per the requirement:
+
:* Power off displays on inactive station after the specified time
+
:* Power off all displays between the time period specified
+
* Click "OK" to complete the process
+
  
All connected displays including the host display will go offline as per the option selected.<br>
+
{|{{Notes}}
 +
|'''Note:'''
 +
* It is strongly recommended to back up your content and display mapping configuration before updating the system. Userful suggests noting down your existing configuration (i.e. sources present and their corresponding display/video wall mapping). <br>
 +
* If you need any help to back up your system that has more than 20-25 different sources, please contact Userful Support or send an email to [mailto:supportteam@userful.com  supportteam@userful.com].
 +
|}
  
=== Reboot and Shut Down System ===  
+
 
Host system can be reboot or Shut down using the "Reboot System" and "Shut Down System" buttons respectively. <br>
+
====Check for Available Packages====
Clicking on each button will bring up a confirmation dialog and once confirmed appropriate action will be performed.
+
[[Image:Additional_Packages.png|right|600px|thumb| Installing Additional Packages]]
 +
 
 +
All the CentOS-provided software packages that come with a base Userful software install are free and open source and can be redistributed under various open-source licensing schemes. However, several essential packages (such as media codecs, capture card drivers) cannot be redistributed freely and must be downloaded and installed from proprietary repositories.  
 
<br>
 
<br>
 +
 +
Userful provides the ability to install additional packages, test videos and software directly through the Control Center. To access this functionality, click "Check for Available Packages" link under "System Updates and Extra Packages". The user can install following packages:
 +
* Desktop Software Suite
 +
* Educational Programs
 +
* LibreOffice
 +
* Media Player Codecs
 +
* Sample Media Content etc.
 +
 +
Select the package and hit "Apply" to start the installation process. Changes will take effect without the system reboot.
 +
<br clear="all"/>
  
 
=== Network Settings===
 
=== Network Settings===
Line 193: Line 328:
 
[[File:UCC_Network_Settings.png|right|thumb|500px|Configuring Network Settings]]
 
[[File:UCC_Network_Settings.png|right|thumb|500px|Configuring Network Settings]]
  
Network Settings section of System Operations displays following information of Network Interface Card:
+
Network Settings section displays following information on Network Interface Card:
 
* Interface Name
 
* Interface Name
 
* Link Status
 
* Link Status
Line 201: Line 336:
 
* Proxy Settings
 
* Proxy Settings
  
"Edit" button located to the right of the IP address opens the network settings configuration box for the host PC/server.  
+
"Edit" button located to the right of the IP address opens the network settings configuration box for the Userful host.  
By default, the Userful host automatically retrieve its network settings and IP Address from router or DHCP server. It is possible to override this setting and manually configure the network.
+
By default, the Userful host automatically retrieves its network settings and IP Address from router or DHCP server. It is possible to override this setting and manually configure the network.
  
 
<br clear="all" /br>
 
<br clear="all" /br>
Line 208: Line 343:
 
[[File:UCC_Proxy.png|right|350px|thumb|Proxy Settings]]
 
[[File:UCC_Proxy.png|right|350px|thumb|Proxy Settings]]
  
The Control Center uses the Internet to contact the Userful licensing server. If the computer system is behind a proxy server, administrators must set a proxy address within the Control Center to allow the Userful host to communicate with the licensing server in order to retrieve licenses.  
+
Control Center uses the Internet to contact the Userful licensing server in order to retrieve licenses, access system updates, and access web browsers via certain sources (e.g., Cloud Desktop, Linux Desktop, Web Browser etc.). If the computer system is behind a proxy server, administrators must set a proxy address within the Control Center to allow the Userful server to access the options requiring the Internet access.  
  
To configure proxy settings, go to <tt>System Operations > Network Settings > Proxy Settings</tt> under Control Center. Select the "Manual Proxy Configuration" option and enter the Userful host proxy address and the TCP port and click "OK".
+
To edit Proxy Settings:
 +
* Go to Control Center
 +
* Click <tt>Settings > Network Settings > Proxy Settings</tt>
 +
* Select the "Manual Proxy Configuration"
 +
* Enter the Userful server proxy address and the TCP port
 +
* Click "OK" to complete the process
 
<br clear="all" /br>
 
<br clear="all" /br>
  
===System Updates===
+
There is also an option to set session-specific proxy settings while configuring [[Docs/Session_Management/Settings#Configure_Session_Settings| Session Management]].
Userful team is continually working to improve product stability and feature set for upcoming version releases. Occasionally, Userful may release important updates between official software version releases. <br>
+
  
The best way to install Userful and other system updates is through <tt>Control Center > System Operations > System Updates</tt>
+
=== Time, Location and Language===
* Click the "Check for Updates" link
+
These settings allow users to change time & date, location, and system language
* Select option as per your maintenance contract and click "Continue" and follow update prompts 
+
  
<br>
+
====Date and Time====
'''Please Note:''' An active Internet connection and a valid Support and Maintenance contract is required to access the software updates.
+
* Users can set date and time manually by entering values in the text box provided or can set it to "Automatic".
  
<br>
+
====Location====
====Additional Packages and Software====
+
* To select a time zone, choose your region and then the nearest city from the drop-down
[[Image:Third_Party_Addons.png|right|400px|thumb| Installing Additional Packages]]
+
* Click OK to complete the process
  
All the CentOS-provided software packages that come with a base Userful&trade; install are free and open source and can be redistributed under various open-source licensing schemes. However, several essential packages (such as media codecs, capture card drivers) cannot be redistributed freely and must be downloaded and installed from proprietary repositories.
+
====System Language====
<br>
+
* Select system language and system keyboard from the drop-down
 
+
* Click OK to complete the process
Userful provides the ability to install additional packages directly through Control Center. To access this functionality, click "Check for Availability" link under "Additional Packages and Software".
+
 
+
Select the package and hit "Apply" to start the installation process. Changes will take effect without the system reboot.
+
<br clear="all"/>
+
 
+
=== Date and Time===
+
Host PC's date and time zone can be changed by clicking on “Change” link.
+
User can edit date and time manually by entering values in the text box provided or can set it to "Automatic".
+
  
===System Language===
+
'''The changes will take effect only after the reboot.'''
System and keyboard language are displayed at the end of System Operations screen. In order to change the language click “Change” link and select System and keyboard language from the drop-down. The changes will take effect only after the reboot.
+
  
 
<br>
 
<br>
Line 247: Line 376:
 
* [[Docs/Control Center | Control Center]]
 
* [[Docs/Control Center | Control Center]]
 
* [[Docs/Failover | Failover Settings]]
 
* [[Docs/Failover | Failover Settings]]
 +
* [[Docs/Remote Control Settings| Remote Control Settings]]
 +
* [[Docs/Performance Settings | Performance Settings]]
  
  

Latest revision as of 14:12, 15 January 2019


Copyright © 2019 Userful Corporation. All rights reserved.
(Updated 2019.01.15)


To return to the main documentation page, Click Here.



Introduction

This section of the Control Center consists of the functions that affect the entire system including the Userful server and all the connected displays. These functions include:

  • Manage System License
  • Change Admin Password
  • Failover Group Settings
  • Remote Control Settings
  • Performance Settings
  • Broadcast Alert
  • Receiver Device Configuration
  • Screen Capture Configuration
  • USB Storage Settings
  • Shared Files Settings
  • Source Content Settings
  • Create Staff User
  • Change root password
  • Change Hostname
  • Power Management
  • Reboot / Shutdown the system
  • Network Settings
  • Manage Updates
  • Manage System Date, Time and Language

General

The settings listed under General category allow users to access some of the key features of Userful™ such as Licensing, Failover Settings, Remote Control Settings etc.

Manage Licensing

With Userful™, Licensing is quickly and easily managed through the Control Center. The unlicensed version of Userful™ is fully functional but will display a brief registration reminder on all attached displays every 20 minutes or so. To enable the full version, you need a valid license for each display.

Getting License Key Online
Manually Install License

To get your Userful host licensed online, Go to "Manage Licensing" link under Settings.

If you already have an activation code:

  1. Enter the Activation Code in the first box.
  2. Enter the maximum number of displays to be used in the second box.
  3. Press "Download and Install License" button to get the license key.

Note: The activation code is tied to a certain number of displays. The number of displays entered cannot exceed the number specified when the activation code was created.

To get the "Activation Code", click "Get Activation Code" and submit the form.

You will need an active Internet connection to automatically install the license key or to submit the request for an activation code.

Your web browser submits the basic system information to the license server as a part of the activation process. This information includes MAC address, Userful™ version, and other hardware information.

The license key file(s) are installed automatically and take effect without rebooting the system.


Installing a License Key from a File
Install License Key

An Internet connection is required to use the activation code to install your license. If there is no Internet connection, email the MAC address or System ID of the Userful host you need to license along with your activation code to the Userful representative. They will generate a license key and send it to you as an attachment.

To install a license key from a file:

  1. Copy the file to the desktop of the system to be licensed or mount a USB flash drive containing the license key file.
  2. From the starting screen of the Licensing section, click on the button marked "Manually Install License File" under Settings > Manage Licensing > Replace License
  3. Click on the "Browse" button and navigate through the file system to the directory where the license key is saved. Select the license key file and choose "Open".
  4. Click on the "Upload License File" button. The license key file is installed automatically and takes effect after rebooting the system.


Increase Licensed Displays
Increase Number of Displays

If your contract allows, it is possible to increase the maximum number of displays connected to a given Userful host without replacing the license. To do this, click on the "Increase Displays" link under Settings > Manage Licensing

If desired, backup the existing license by clicking the "Backup your current license file” link in the dialogue that appears.

Enter the “Activation Code” and the new "Maximum Number of Displays". Click on the "Request Increase from License Server" button to complete the operation. Please Note: The new maximum number of displays entered must be greater than the current maximum.

The "License Details" will now reflect the increased Maximum Number of Displays.

Backing up a License File
  • To back up a license file, go to Settings > Manage Licensing and click the "Download/Backup current license".
    • This will open a dialogue box asking to confirm the file-saving operation. Click "Save" to save a copy of the license file with a ".bak" file extension in the /etc/userful/license/ directory.
Replacing an Existing License

Sometimes it may be necessary to replace a license on a working system; for example, to add more displays to the license. Contact your Userful representative if you have any questions about obtaining a replacement license.
To replace a license, go to Settings > Manage Licensing and click the "Replace License" button. Follow the instructions to either get a license through the Internet (if you have an activation code) or install a license file manually.

Note: License persist when the product is upgraded to a newer version. That is, if you already have a license for a version of Userful™, you can update your system to the newest available version without obtaining a new license as long as you have an active maintenance and support contract.


Change Server Name

Change Server Name

User can change Server Name using this link.

  • Click on Control Center > Settings > Change Server Name link
  • A window will popup, enter New Server Name
  • Click "OK" to complete the process


This will restart all connected receiver devices and Control Center will be blocked until all the receiver devices come back online and the server name is changed successfully.

Failover Group Settings

Failover eliminates the risk of single point of failure. It requires at least two Userful servers in the same subnet. In the event of failure, secondary server can take over the displays that were assigned to the primary server. Please refer to Failover page for detailed information.


Remote Control Settings

Userful™ software appliance lists down various Remote Control Settings that user can enable or use to remotely control and interact with stand-alone displays and video walls. These settings include features like Source Switcher, Preset Switcher, and Interactive Viewer.

Note: Appropriate license tier or Advanced Subscription is required to access these features, please contact your Sales Representative or send an email to sales@userful.com for more details.


Remote Control Settings
Source Switcher

Source Switcher is available under all license tiers except Basic. It allows users to launch and switch source on displays and video walls using a single-click, it can be accessed from any web browser within the same network, using any device including smartphones and tablets. For more information, visit Source Switcher.

Preset Switcher

Preset Switcher is available only under "Ultimate" license or "Advanced Subscription". It allows users to launch and switch between the saved preset (i.e., display mapping configuration) using a single-click, it can be accessed from any web browser within the same network, using any device including smartphones and tablets. For more information, visit Preset Switcher .

Interactive Viewer

Interactive Viewer is available only under "Ultimate" license or "Advanced Subscription". It allows users to remotely interact with standalone displays or video walls playing Interactive sources (e.g., Web Browser, Linux Desktop, Cloud Desktop etc.), via keyboard and mouse of a different computer such as Userful host, connected display or any device in the same local area network. For more information on how to use this feature, visit Interactive viewer.

Performance Settings

Performance Settings

Userful™ software appliance lists down system-level settings that user can use or enable for optimal performance and content synchronization. These settings include features like Nvidia Offload Support, Intel Offload Support, Direct Sync and Display Scaling. For more information, visit Performance Settings.

Broadcast Alert

Broadcast Alerts

Broadcast Alert allows the administrator to send short messages or alerts across online displays. To send message/alert across displays :

  • From the "Control Center" Navigation Panel, go to Settings
  • Enter the message in the text area provided.
  • Select "Alert level"
  • Select Display Length/Time Duration for a message from the drop-down (e,g. display a message for 2 minutes)
  • Click "Start Broadcast" button

The message will be displayed on all online displays including the Userful host. Admin can cancel a message broadcast by simply clicking the "Stop Broadcast" button.


Receiver Device Configuration

Zero-Client Configuration

Receiver Device Configuration specifies how new receiver devices are assigned to the Userful server (i.e., automatic or manual). Select one of the following options:

  • Automatically assign new receiver devices to this Userful server, or
  • Manually assign new receiver devices to this Userful server

By default, administrators have to manually assign receiver devices to the Userful server. To assign receiver devices, please visit Managing Displays.


Screen Capture Configuration

Screen Capture Configuration

Screen Capture feature lets you view actual playing content on the video wall(s) and display(s) from GUI. Follow below mentioned steps to configure Screen Capture:

  • Open Control Center
  • Go to Settings > Screen Capture Configuration
  • Enable Screen Capture to view the actual content playing from UI
Screen capture button will appear on Control Center > Mapping below the "New Video Wall" button.
  • Enable Auto Refresh to capture the content on all the display(s) refreshing itself as per the specified time.
Please note that the default time is 10 seconds.
Mapping-Screen Capture
  • Go to Mapping
  • Click "Screen Capture" button to view the actual playing content on the display icons, OR
  • Double click on the display icon to view the actual playing content inside Display Settings dialog window



Storage Management

Storage Settings allow users to transfer and access files across displays. It enables users to configure various settings and optional password protection feature to access "shared-files" folder.

USB Storage Settings

USB Storage Settings

This option allows users to mount USB storage devices from certain interactive sources like Linux Desktop and Cloud Desktop. To allow access to USB storage devices:

  • Enable access to USB storage
  • Click OK to complete the process

Note: USBs cannot be mounted by default, as the initial setting of "Enable access to USB storage" is Off.

Shared Files Settings

Desktop Shared Files Settings
Desktop Shortcut

This option enables easy access to "shared-files" folder on the native desktops. (i.e., Cloud Desktop and Linux Desktop)

Auto Cleanup

This option enables deletion of the unused files under "shared-files" folder that have not been accessed within the specified number of days.

Source Content Settings

Source Content Settings
Browser Access

This option provides read-only access to source content from the Web Browser. Users can see the list of files by typing http://localhost:81 or http://[Userful server IP Address]:81 in the browser’s address bar.

FTP and Network Share Access

This option enables password protection feature for FTP Server Access and Network Share Access. If enabled, users will need to use "files" as username along with the specified password.

Network Share Access

This option provides access across the network, e.g.:

  • Windows users can access the folder by typing \\[Userful server IP Address] in a browser.
  • Mac users can access shared-files folder from Finder > Go > Connect to Server
FTP Server Access

This option allows users to access the source-content folder using a FTP client.


User Management

The settings listed under User management allow users to change the root password, create staff user, change staff password to maintain the proper authentication process

Change root Password

Change root Password

Userful™ software appliance does not set the root password by default. Root access is only necessary for non-graphical troubleshooting and advanced integration. User can set and change root password using this link. To do so:

  • From the "Control Center" Navigation Panel, go to Settings
  • Click on the "Change root Password" link
  • A window will pop with an advise not to set the root password as this will limit the level of support from the Userful team
  • Click OK to continue
  • A window will pop up, enter New Password and Repeat Password
  • Click "OK" to complete the process

The change will take effect immediately without the system reboot.

Change user Password

Change User Password

To change the user account password set during the "Initial Setup" process, click "Change user Password" link

  • A window will pop up, enter the current password, new password and repeat password in the respective fields
  • Click "OK" to complete the process

The change will take effect immediately without system reboot.

Create staff User

Create Staff User

With the release of Userful 8.6, Userful provides the ability to create "staff" user account for limited access functionality. A staff user will have limited privileges as compared to an "admin" user (user account created during the Initial Setup) and can access following Control Center features:

  • Play and pause video playback
  • Interact with video walls via Interactive Viewer functionality
  • Remap displays and video walls to existing sources
  • Create Mirror groups
  • Reboot / Shutdown the Userful host
  • Reset zero client devices
  • Broadcast alert messages
  • Contact Support and access to support portal

To create and edit the staff user account:

  • Open Control Center > Settings and click "Create staff user"
  • Enter the data in the "New Password" and "Repeat Password" fields
  • Click OK to complete the process

Once completed, log out of the Control Center. On the login screen "staff" user is listed under the available username drop-down.

Power Management

The settings listed under this category allow users to conserve power and improve the stability of the system

Automatic Nightly Shutdown / Reboot (Server)

Automatic Nightly Shutdown

To conserve power and to ensure proper shutdown or reboot of the Userful server, you can enable automatic shutdown/reboot process. To enable this:

  1. Click "Auto Nightly Shutdown / Reboot (Server)" link
  2. Enable the checkbox and choose between the toggle button Shutdown or Reboot the Userful server
  3. Enter the time in (HH/MM) format

Note: Warning message will pop 5 minutes before the scheduled time to notify all users to save their work.

Control Center also provides instructions to do automatic power-on using BIOS. This feature is particularly helpful if it is hard to access Userful server physically. Click on the " change BIOS settings" link and follow the instructions.

Power Management (Display)

Power Management

Userful™ software provides an option to save power for receiver devices. It can also be used to maximize the useful life of display devices including projectors. To enable power management for displays:

  • Open Control Center > Settings > Power Management (Display).
  • Enable the options available as per the requirement:
  • Show screen saver after the specified time
  • Enter the screen saver directory
  • Enter the screen saver interval(s)
  • Power off displays on inactive display after the specified time
  • Power off all displays between the specified time period
  • Click "OK" to complete the process

All connected displays including the host display will go offline as per the option selected.

Note: Screensaver can only be activated on certain sources (e.g., Welcome Screen, Cloud Desktop etc.)


Reboot and Shut Down System

Userful server can be reboot or shut down using the "Reboot System" and "Shut Down System" links respectively.
Clicking on each button will bring up a confirmation dialog and once confirmed appropriate action will be performed.

System Updates and Extra Packages

Userful team is continually working to improve product stability and feature set for upcoming version releases. Occasionally, Userful may release important updates between official software version releases.

Note: An active Internet connection and a valid Maintenance and Support contract is required to access the software updates. Please contact your Sales Representative or send an email to sales@userful.com for more details.

Check for System Updates

The best way to install Userful and other system updates is through Control Center > Settings

  • Click the "Check for System Updates" link
  • Select option as per your maintenance contract and click "Continue" and follow the update prompts.
  • Reboot the system after update.
Note:
  • It is strongly recommended to back up your content and display mapping configuration before updating the system. Userful suggests noting down your existing configuration (i.e. sources present and their corresponding display/video wall mapping).
  • If you need any help to back up your system that has more than 20-25 different sources, please contact Userful Support or send an email to supportteam@userful.com.


Check for Available Packages

Installing Additional Packages

All the CentOS-provided software packages that come with a base Userful software install are free and open source and can be redistributed under various open-source licensing schemes. However, several essential packages (such as media codecs, capture card drivers) cannot be redistributed freely and must be downloaded and installed from proprietary repositories.

Userful provides the ability to install additional packages, test videos and software directly through the Control Center. To access this functionality, click "Check for Available Packages" link under "System Updates and Extra Packages". The user can install following packages:

  • Desktop Software Suite
  • Educational Programs
  • LibreOffice
  • Media Player Codecs
  • Sample Media Content etc.

Select the package and hit "Apply" to start the installation process. Changes will take effect without the system reboot.

Network Settings

Configuring Network Settings

Network Settings section displays following information on Network Interface Card:

  • Interface Name
  • Link Status
  • IP Address
  • Lease Time
  • DNS
  • Proxy Settings

"Edit" button located to the right of the IP address opens the network settings configuration box for the Userful host. By default, the Userful host automatically retrieves its network settings and IP Address from router or DHCP server. It is possible to override this setting and manually configure the network.


Proxy Settings

Proxy Settings

Control Center uses the Internet to contact the Userful licensing server in order to retrieve licenses, access system updates, and access web browsers via certain sources (e.g., Cloud Desktop, Linux Desktop, Web Browser etc.). If the computer system is behind a proxy server, administrators must set a proxy address within the Control Center to allow the Userful server to access the options requiring the Internet access.

To edit Proxy Settings:

  • Go to Control Center
  • Click Settings > Network Settings > Proxy Settings
  • Select the "Manual Proxy Configuration"
  • Enter the Userful server proxy address and the TCP port
  • Click "OK" to complete the process


There is also an option to set session-specific proxy settings while configuring Session Management.

Time, Location and Language

These settings allow users to change time & date, location, and system language

Date and Time

  • Users can set date and time manually by entering values in the text box provided or can set it to "Automatic".

Location

  • To select a time zone, choose your region and then the nearest city from the drop-down
  • Click OK to complete the process

System Language

  • Select system language and system keyboard from the drop-down
  • Click OK to complete the process

The changes will take effect only after the reboot.


Related Links