Getting Started with Frame App

Setting up Frame App for your client base is simple and can be done in a few steps. The following guide will outline where/how to install Frame App, how Frame App handles updates, how to navigate through Frame App, and much more. Use the links below to jump to different sections of this guide, if needed.

Installation

Frame App installation and setup is uncomplicated and should only take a few minutes.

  1. First, navigate to the Frame downloads page. Note: You will be prompted to log in with your My Nutanix account if not already signed in.

  2. Find the latest Frame App version for your desired operating system.

    ../../_images/frapp_gsg1.png
  3. Your download should automatically begin. Once completed, run the file to start the installation process.

  4. Follow the prompts, you will be asked to define the directory where you want the application installed.

    ../../_images/frapp_gsg2.png
  5. Click “Finish” after running through the installation wizard.

    ../../_images/frapp_gsg3.png

Silent Installation for Windows

For customers who wish to deploy Frame App through a silent installation process for Windows, this can be done by invoking msiexec, as a Windows administrator with the Frame App MSI package, starting with Frame App 5.11. A basic silent install of Frame App 5.11 would have a command line:

msiexec /i Frame-5.11.0.msi /qn

To generate an installation log during the silent install, a sample command line would be:

msiexec /i Frame-5.11.0.msi /L*V "FrameApp.log" /qn

Silent Install Arguments

With Frame App 6.0 and higher, customer administrators can set the values of the Preferences during the silent installation of the Frame App MSI package.

Note

If preferences are to be set during the silent installation process with Frame App 5.11, you must uninstall the previous version, if one exists, before starting the silent installation with the Preferences arguments. Existing application can be silently uninstalled using msiexec /x with the corresponding Frame App MSI package.

Warning

If one of following command arguments does not use one of the supported values (e.g., ON or OFF), the silent installation will fail.

The following arguments are supported:

Silent Installation Arguments

Argument

Details

Example

ADVANCED_USB

Frame App will not allow advanced USB redirection when this argument is set to OFF. The default value is ON.

ADVANCED_USB="OFF"

ALLUSERS

Frame App will be installed for the current user, by default. To install for all users, set ALLUSERS=1.

ALLUSERS=1

CHECK_FOR_UPDATES_ON_STARTUP

Frame App will not check for updates at startup when this argument is set to OFF. The default value is ON.

CHECK_FOR_UPDATES_ON_STARTUP="OFF"

CLEAR_CACHE_ON_STARTUP

Frame App will clear the local cache on startup when this argument is set to ON. The default value is OFF.

CLEAR_CACHE_ON_STARTUP=ON

FORCE

Set this argument value to “ON” if you wish to replace the existing Preference values with new values and prevent users from changing the values. The default value is OFF.

FORCE="ON"

INSTALL_DRIVERS

Set this argument value to “ON” if you wish to install the Nutanix Frame Virtual USB driver for Advanced USB redirection. If the Virtual USB driver is installed, a reboot will be required to finish the installation of the driver. The default value is ON.

INSTALL_DRIVERS="OFF"

SEND_ERROR_REPORTS

Set this argument value to “OFF” if you do not want Frame App to send error reports to Nutanix. The default value is ON.

SEND_ERROR_REPORTS="OFF"

STARTUP_URL

Sets the URL that Frame App will go to once Frame App is launched. Be sure the URL is double quoted. The default value is https://console.nutanix.com.

STARTUP_URL="https://console.nutanix.com/customer/?idp=frame-azuread"

For example, to install Frame App for all users, set the Startup URL, ensure the local cache is cleared at startup, suppress auto-updates, and prevent users from changing the Preferences values, the command line would be:

msiexec /i Frame-5.11.0.msi /L*V "FrameApp.log" ALLUSERS=1 STARTUP_URL="https://console.nutanix.com/customer-name/?idp=frame-azuread" CLEAR_CACHE_ON_STARTUP="ON" CHECK_FOR_UPDATES_ON_STARTUP="OFF" FORCE="ON" /qn

Note that the following msiexec.exe commands can be used:

msiexec arguments

Argument

Details

/i

Normal install

/norestart

Do not restart the device after the installation completes.

/qn

No UI during the installation process

/quiet

No user interaction required

Updates

Once installed, Frame App will automatically check for updates every time you launch it. You will be prompted to update your version of Frame App if any newer versions are available.

To check your version of Frame App, simply navigate to the “Help” menu and select “About.”

../../_images/frapp_gsg4.png

Launchpad Access

If you would like to allow your end users to download Frame App to their endpoint device directly from their Frame Launchpad, simply click on the kebab menu next to the desired Customer entity, select Update, and navigate to the Settings tab of the desired Customer entity and enable the setting:

../../_images/enable_download_frapp.png

Once this toggle is enabled, a new notification will appear in the upper right corner of their Launchpad the next time log in:

../../_images/frapp_download2.png

End users may also click on their name in the upper right corner at any time to see the option to download for their eligible endpoint device:

../../_images/frapp_download3.png

Using Frame App

To launch Frame App from your local machine, simply click on the icon:

../../_images/eu_fapp11.png

Using Frame App is simple, and there are only a few differences from using Frame in a web browser.

../../_images/eu_fapp21.png

The menu options and definitions are as follows:

  • Frame > Quit Frame: Closes the window. If you select this option while in a session, your session will only disconnect. You will still be able to access your session by relaunching Frame App. This is different than closing the session. See our glossary for a more detailed explanation.

  • View > Reload: Reloads the window. Performs the same action as the “refresh” button in a web browser.

  • View > Show Certificate: This window displays SSL connection and certificate information.

  • View > Toggle Full Screen: Enables/disables full screen mode.

  • History> Back/Forward: The Frame App equivalent of the back and forward buttons in a modern web browser.

  • Help > About: Provides information about Frame App including version number and a link to our EULA.

  • Help > Preferences: Opens the “Preferences” window where administrators can set the startup URL for Frame App. We will describe this in more detail in the next Frame App guide.

Now that you have successfully installed Frame App and understand the basics, you can move on to the Frame App Configuration Guide.