{"_id":"5923bb6ca341250f008c8d3d","category":{"_id":"55e75b39e06f4b190080dbfe","project":"55d535ca988e130d000b3f5c","__v":10,"pages":["56959043fe18811700c9c09e","569590bfcb14e11700f8a877","569590f7fcb1032d0089e033","5695917dfcb1032d0089e035","5695964a77ba0d2300cf3912","5695967edcaf0d1700cb8752","569618eccb14e11700f8a910","56961d937596a90d0014e571","5696ba13480534370022a37a","56dd002ee5c8570e00a79865"],"version":"55d535cb988e130d000b3f5f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-02T20:25:29.622Z","from_sync":false,"order":3,"slug":"frame-for-business","title":"Frame for Business"},"version":{"_id":"55d535cb988e130d000b3f5f","__v":13,"project":"55d535ca988e130d000b3f5c","hasDoc":true,"hasReference":false,"createdAt":"2015-08-20T02:04:59.052Z","releaseDate":"2015-08-20T02:04:59.052Z","categories":["55d535cc988e130d000b3f60","55d6b238d2a8eb1900109eef","55d6b4f3250d7d0d004274cd","55d7967960fc730d00fc2852","55da9804e835f20d009fc5d0","55e75b1de06f4b190080dbfd","55e75b39e06f4b190080dbfe","55e75b7ae06f4b190080dbff","564f5a4e33082f0d001bb709","570fb64aa38d470e0060cbff","586d0dd89a854123001acd65","586d0e3b9a854123001acd66","5a613b28da07540012e8ca4a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"githubsync":"","parentDoc":null,"project":"55d535ca988e130d000b3f5c","user":"55d535835082980d0009c965","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-23T04:32:44.586Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"You can customize many aspects of how your users' sessions will behave when running on Frame. The Session Settings console was created to give you fine granularity over these customizations. You can assign different users to different sets of settings depending on their workflows. \n\nIn Frame for Business accounts and any account where your users launch applications from the Frame Launchpad, you have a single set of session settings that apply as the \"default.\"  Go to the Session Settings tab in the Settings section of the Dashboard to configure these session behaviors. Click on the \"gear\" icon on the right side of the \"Default\" row and select \"Edit\" to access the Session Settings window. If you'd like to create a new set, you can select the \"Add new\" option above the \"Name\" heading. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Default Session Settings\",\n  \"body\": \"Your Sandbox doesn’t have a separate set of session settings so it implicitly uses the “Default” profile. So, any changes you make to the \\\"Default\\\" set of Session Settings will be applied to your Sandbox automatically.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7af4395-updated1.png\",\n        \"updated1.png\",\n        1335,\n        517,\n        \"#252728\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nThese settings let you configure how the session will behave when users launch any application from the Launchpad. For example, you can choose to show or hide the distance and latency measurements shown in the bottom of the session status bar.  We'll go over each heading within the \"Session settings\" window below. \n[block:api-header]\n{\n  \"title\": \"Display\"\n}\n[/block]\nYou can edit the name of your default settings under the \"Display\" heading at the top. If you are adding a new set of custom session settings, you will need to enter a name in order to save them.   \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2a44ffa-display1.png\",\n        \"display1.png\",\n        706,\n        263,\n        \"#e6efee\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Settings\"\n}\n[/block]\nMoving on to the next section, \"Settings,\" you'll see various toggles. Some of them are self-explanatory, but we'll go over them in more detail here. Note that depending on your product tier, you may only see a subset of these options.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ee78883-sessionsettings.png\",\n        \"sessionsettings.png\",\n        681,\n        534,\n        \"#e3e7e8\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n*** Collect feedback at session end ***\nUsers will be prompted to provide feedback on their experience at the end of the session. You can review the information on an ongoing basis in the Analytics section.\n\n*** Collect feedback during session ***\nAllows users to submit feedback about the session from the Settings Menu (gear icon) during a session.\n\n*** Show distance warning ***\nA message appears at the start of the session warning the user if their distance to the datacenter is estimated at over 1000 miles (based on the geolocation of their IP address).\n\n*** Show distance elements ***\nAllows you to show or hide the distance metric from the Frame status bar at the bottom of users' session windows. You may want to consider disabling this option since the distance is only an approximation based on the registered location of the user's IP address. In some cases, their IP address may be registered in a totally different place from where they are located, resulting in a false distance measurement. The best measure of performance is the latency and should be the primary focus for an end-user. \n\n*** Show latency measure ***\nDisplays the latency measurement to the user in the session's Status Bar.\n\n*** Allow secondary apps ***\nAllows the user to launch secondary applications within the same session as their primary application. This is typically used with the embedded player flow. \n\n ***Enable mouse mode selection ***\nExposes special mouse modes (normal and relative) via an icon in the session's Status Bar.\n\n*** Run apps using native iOS application ***\nAllows users to run an application using the native Frame iOS application. \n\n*** Enable microphone ***\nEnables audio input when using applications in the session.\n\n***Fake Chromebook left Alt-click***\nDisables the normal behavior of Chromebook’s left Alt-click.\n\n*** Clipboard integration ***\nEnables clipboard functionality which lets users cut and paste text between their local device and the Frame session.\n\n*** Allow anonymous sessions *** \nAllows starting an application as an anonymous user.\n\n*** Download ***\nEnables downloading files from the remote session to the user's local device.\n\n*** Upload ***\nEnables uploading files from the user's local device to their Frame session.\n\n*** Print ***\nEnables printing files from the remote session to the Frame Virtual Printer.\n\n*** Secure print ***\nEnables a special printing mode which only displays the printed output as a PDF in another browser tab on the user's local browser. The file is not downloaded to their local \"Downloads\" folder.  \n\n*** Clipboard sync ***\nEnables automatic syncing of the clipboard between the user's local device and the clipboard within the Frame session (works with copy and paste via key combination:  CTRL+C and CTRL+V).\n\n[block:api-header]\n{\n  \"title\": \"Storage\"\n}\n[/block]\nYou can enable/disable various cloud storage integration options for your users under the \"Storage\" section of session settings.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3ad159a-storageupdated1.png\",\n        \"storageupdated1.png\",\n        726,\n        186,\n        \"#5d7892\"\n      ]\n    }\n  ]\n}\n[/block]\n*** Enable Dropbox ***\nAllows users to connect to their Dropbox account. \n\n*** Enable Google Drive ***\nAllows users to connect to their Google Drive account. \n\n*** Enable Box ***\nAllows users to connect to their Box account. \n[block:api-header]\n{\n  \"title\": \"Time Limits\"\n}\n[/block]\nThe \"Time Limits\" section displays three parameters which control how long sessions can run. We'll go over the description of each parameter below. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/27326d3-timelimits.png\",\n        \"timelimits.png\",\n        651,\n        222,\n        \"#e7efee\"\n      ]\n    }\n  ]\n}\n[/block]\n*** User inactivity timeout *** \nThis is the maximum amount of time that Frame will keep a session connected when there is no user activity (no mouse/keyboard events). Frame will display a warning at the \"1 minute left\" mark and then disconnect the session afterward.\n\n  * Default value: 10 minutes\n  * Minimal value: 1 minute\n \n*** Idle timeout ***  \nFor any sessions that are launched from the Launchpad (which is the most common use case for Frame for Business/Education accounts), authenticated users can disconnect from a session and reconnect later to the same running session. The \"idle time\" setting refers to the amount of time that a session will be kept active after an authenticated user disconnects from the session (by closing the application within the session, by disconnecting from the gear menu, by closing their browser tab, or by getting disconnected due to a network issue). \n\n* Default value: 10 minutes\n* Minimal value: 0\n\n*** Max session duration ***\nThis is the maximum length of time that a session can run. The duration is shown on the status bar countdown timer in the session itself. \n* Default value: 1 hour\n* Minimal value: 0 (infinite session duration)\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Infinite Session duration\",\n  \"body\": \"Setting the max session duration to 0 allows your users to remain logged into a session until they are no longer active. This option should only be considered if you are aware of the possible costs associated with infinite session duration.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Resolution\"\n}\n[/block]\nThe Resolution section allows you to choose between fixed screen resolutions and a dynamic screen resolution. You can also choose which options you want to make visible to your users from within their session.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/96b21b7-resolution1.png\",\n        \"resolution1.png\",\n        693,\n        298,\n        \"#598cc5\"\n      ]\n    }\n  ]\n}\n[/block]\n**Default:** The first field lets you select which resolution mode is set as the default when an application is first started.  \n\nIf you choose \"Dynamic\" as the default, the application will always start by fitting to the size of the user's browser window and maintaining a 100% scale setting for the best possible quality.\n  \nYou can also choose a fixed resolution as the default startup resolution. With a fixed resolution, the app will display in this resolution at 100% scale, so long as the user's browser window is larger than the set resolution. If the browser window is smaller than the fixed resolution, the image will be scaled down by the amount shown in the bottom status bar of the player. \n\n**Available user choices:** This section controls what your users will see in the player and whether or not resolution options are visible.\n\nIf only the default is selected from the list (automatically chosen based on the \"Default\" setting), then the user will have no control over the resolution setting in the player. However, if you select additional user choices, a \"Resolution\" menu item will appear in the settings menu of the player, and users can choose which option they want.\n\nNote that this setting can be configured individually for each application that you publish.\n\n[block:api-header]\n{\n  \"title\": \"Custom dialogs\"\n}\n[/block]\nDepending on your subscription type, you may be able to create custom dialogs and enable specific warning messages to your users. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e528680-customdialogs.png\",\n        \"customdialogs.png\",\n        679,\n        424,\n        \"#d6d9dc\"\n      ],\n      \"caption\": \"When \\\"Show disclaimer\\\" is enabled, two fields will appear for you to enter the title and content you'd like to display to your users.\"\n    }\n  ]\n}\n[/block]\n*** Show disclaimer ***\nDisplays a custom disclaimer dialog when the session starts.\n\n*** Prompt user about low resolution ***\nDisplays a warning dialog at session start if the user is below a specified resolution. \n\n*** Show About dialog ***\nEnables About dialog that can be accessed within a session.\n\n*** Show tips ***\nDisplays a custom tip dialog when the session starts. \n\n***  Use custom feedback content ***\nAllows the standard feedback form to be replaced with a custom HTML one.\n[block:api-header]\n{\n  \"title\": \"Advanced options\"\n}\n[/block]\nUnder this heading, you will see a text box titled \"Start parameters.\" Here, you can enter advanced configuration flags to control the behavior of a session. The vast majority of users will never need to interface with this as it is primarily used by Frame support for special configurations. This option is available to Biz Admins if enabled by Frame support. Frame Platform Ultimate accounts can enable this for any accounts they own. \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1ca5190-advancedoptions1.png\",\n        \"advancedoptions1.png\",\n        652,\n        202,\n        \"#cccccf\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Applying session settings to embedded players and Launchpad\"\n}\n[/block]\nIf you have multiple sets of session settings, you'll need to specify which set applies to your embedded players and which applies to your Launchpad. \n\nTo set the embedded player session settings, go to the \"Embed App\" section for the app in question (click on the arrow next to the app icon in the Dashboard and select \"Embed app\"). Then scroll to the bottom of the section where you can select which session settings to apply:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ca43ca8-embeddedplayer1.png\",\n        \"embeddedplayer1.png\",\n        1454,\n        1068,\n        \"#1b1b1b\"\n      ]\n    }\n  ]\n}\n[/block]\nSimilarly, you can select which session settings to apply to your Launchpad by going to the \"Manage Windows App\" section in your Launchpad as an admin: \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1be99f0-c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png\",\n        \"c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png\",\n        1854,\n        1208,\n        \"#657079\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Control how your applications behave","slug":"configure-session-settings","type":"basic","title":"Configuring session settings"}

Configuring session settings

Control how your applications behave

You can customize many aspects of how your users' sessions will behave when running on Frame. The Session Settings console was created to give you fine granularity over these customizations. You can assign different users to different sets of settings depending on their workflows. In Frame for Business accounts and any account where your users launch applications from the Frame Launchpad, you have a single set of session settings that apply as the "default." Go to the Session Settings tab in the Settings section of the Dashboard to configure these session behaviors. Click on the "gear" icon on the right side of the "Default" row and select "Edit" to access the Session Settings window. If you'd like to create a new set, you can select the "Add new" option above the "Name" heading. [block:callout] { "type": "warning", "title": "Default Session Settings", "body": "Your Sandbox doesn’t have a separate set of session settings so it implicitly uses the “Default” profile. So, any changes you make to the \"Default\" set of Session Settings will be applied to your Sandbox automatically." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/7af4395-updated1.png", "updated1.png", 1335, 517, "#252728" ], "border": true } ] } [/block] These settings let you configure how the session will behave when users launch any application from the Launchpad. For example, you can choose to show or hide the distance and latency measurements shown in the bottom of the session status bar. We'll go over each heading within the "Session settings" window below. [block:api-header] { "title": "Display" } [/block] You can edit the name of your default settings under the "Display" heading at the top. If you are adding a new set of custom session settings, you will need to enter a name in order to save them. [block:image] { "images": [ { "image": [ "https://files.readme.io/2a44ffa-display1.png", "display1.png", 706, 263, "#e6efee" ], "border": true } ] } [/block] [block:api-header] { "title": "Settings" } [/block] Moving on to the next section, "Settings," you'll see various toggles. Some of them are self-explanatory, but we'll go over them in more detail here. Note that depending on your product tier, you may only see a subset of these options. [block:image] { "images": [ { "image": [ "https://files.readme.io/ee78883-sessionsettings.png", "sessionsettings.png", 681, 534, "#e3e7e8" ], "border": true } ] } [/block] *** Collect feedback at session end *** Users will be prompted to provide feedback on their experience at the end of the session. You can review the information on an ongoing basis in the Analytics section. *** Collect feedback during session *** Allows users to submit feedback about the session from the Settings Menu (gear icon) during a session. *** Show distance warning *** A message appears at the start of the session warning the user if their distance to the datacenter is estimated at over 1000 miles (based on the geolocation of their IP address). *** Show distance elements *** Allows you to show or hide the distance metric from the Frame status bar at the bottom of users' session windows. You may want to consider disabling this option since the distance is only an approximation based on the registered location of the user's IP address. In some cases, their IP address may be registered in a totally different place from where they are located, resulting in a false distance measurement. The best measure of performance is the latency and should be the primary focus for an end-user. *** Show latency measure *** Displays the latency measurement to the user in the session's Status Bar. *** Allow secondary apps *** Allows the user to launch secondary applications within the same session as their primary application. This is typically used with the embedded player flow. ***Enable mouse mode selection *** Exposes special mouse modes (normal and relative) via an icon in the session's Status Bar. *** Run apps using native iOS application *** Allows users to run an application using the native Frame iOS application. *** Enable microphone *** Enables audio input when using applications in the session. ***Fake Chromebook left Alt-click*** Disables the normal behavior of Chromebook’s left Alt-click. *** Clipboard integration *** Enables clipboard functionality which lets users cut and paste text between their local device and the Frame session. *** Allow anonymous sessions *** Allows starting an application as an anonymous user. *** Download *** Enables downloading files from the remote session to the user's local device. *** Upload *** Enables uploading files from the user's local device to their Frame session. *** Print *** Enables printing files from the remote session to the Frame Virtual Printer. *** Secure print *** Enables a special printing mode which only displays the printed output as a PDF in another browser tab on the user's local browser. The file is not downloaded to their local "Downloads" folder. *** Clipboard sync *** Enables automatic syncing of the clipboard between the user's local device and the clipboard within the Frame session (works with copy and paste via key combination: CTRL+C and CTRL+V). [block:api-header] { "title": "Storage" } [/block] You can enable/disable various cloud storage integration options for your users under the "Storage" section of session settings. [block:image] { "images": [ { "image": [ "https://files.readme.io/3ad159a-storageupdated1.png", "storageupdated1.png", 726, 186, "#5d7892" ] } ] } [/block] *** Enable Dropbox *** Allows users to connect to their Dropbox account. *** Enable Google Drive *** Allows users to connect to their Google Drive account. *** Enable Box *** Allows users to connect to their Box account. [block:api-header] { "title": "Time Limits" } [/block] The "Time Limits" section displays three parameters which control how long sessions can run. We'll go over the description of each parameter below. [block:image] { "images": [ { "image": [ "https://files.readme.io/27326d3-timelimits.png", "timelimits.png", 651, 222, "#e7efee" ] } ] } [/block] *** User inactivity timeout *** This is the maximum amount of time that Frame will keep a session connected when there is no user activity (no mouse/keyboard events). Frame will display a warning at the "1 minute left" mark and then disconnect the session afterward. * Default value: 10 minutes * Minimal value: 1 minute *** Idle timeout *** For any sessions that are launched from the Launchpad (which is the most common use case for Frame for Business/Education accounts), authenticated users can disconnect from a session and reconnect later to the same running session. The "idle time" setting refers to the amount of time that a session will be kept active after an authenticated user disconnects from the session (by closing the application within the session, by disconnecting from the gear menu, by closing their browser tab, or by getting disconnected due to a network issue). * Default value: 10 minutes * Minimal value: 0 *** Max session duration *** This is the maximum length of time that a session can run. The duration is shown on the status bar countdown timer in the session itself. * Default value: 1 hour * Minimal value: 0 (infinite session duration) [block:callout] { "type": "danger", "title": "Infinite Session duration", "body": "Setting the max session duration to 0 allows your users to remain logged into a session until they are no longer active. This option should only be considered if you are aware of the possible costs associated with infinite session duration." } [/block] [block:api-header] { "title": "Resolution" } [/block] The Resolution section allows you to choose between fixed screen resolutions and a dynamic screen resolution. You can also choose which options you want to make visible to your users from within their session. [block:image] { "images": [ { "image": [ "https://files.readme.io/96b21b7-resolution1.png", "resolution1.png", 693, 298, "#598cc5" ] } ] } [/block] **Default:** The first field lets you select which resolution mode is set as the default when an application is first started. If you choose "Dynamic" as the default, the application will always start by fitting to the size of the user's browser window and maintaining a 100% scale setting for the best possible quality. You can also choose a fixed resolution as the default startup resolution. With a fixed resolution, the app will display in this resolution at 100% scale, so long as the user's browser window is larger than the set resolution. If the browser window is smaller than the fixed resolution, the image will be scaled down by the amount shown in the bottom status bar of the player. **Available user choices:** This section controls what your users will see in the player and whether or not resolution options are visible. If only the default is selected from the list (automatically chosen based on the "Default" setting), then the user will have no control over the resolution setting in the player. However, if you select additional user choices, a "Resolution" menu item will appear in the settings menu of the player, and users can choose which option they want. Note that this setting can be configured individually for each application that you publish. [block:api-header] { "title": "Custom dialogs" } [/block] Depending on your subscription type, you may be able to create custom dialogs and enable specific warning messages to your users. [block:image] { "images": [ { "image": [ "https://files.readme.io/e528680-customdialogs.png", "customdialogs.png", 679, 424, "#d6d9dc" ], "caption": "When \"Show disclaimer\" is enabled, two fields will appear for you to enter the title and content you'd like to display to your users." } ] } [/block] *** Show disclaimer *** Displays a custom disclaimer dialog when the session starts. *** Prompt user about low resolution *** Displays a warning dialog at session start if the user is below a specified resolution. *** Show About dialog *** Enables About dialog that can be accessed within a session. *** Show tips *** Displays a custom tip dialog when the session starts. *** Use custom feedback content *** Allows the standard feedback form to be replaced with a custom HTML one. [block:api-header] { "title": "Advanced options" } [/block] Under this heading, you will see a text box titled "Start parameters." Here, you can enter advanced configuration flags to control the behavior of a session. The vast majority of users will never need to interface with this as it is primarily used by Frame support for special configurations. This option is available to Biz Admins if enabled by Frame support. Frame Platform Ultimate accounts can enable this for any accounts they own. [block:image] { "images": [ { "image": [ "https://files.readme.io/1ca5190-advancedoptions1.png", "advancedoptions1.png", 652, 202, "#cccccf" ] } ] } [/block] [block:api-header] { "title": "Applying session settings to embedded players and Launchpad" } [/block] If you have multiple sets of session settings, you'll need to specify which set applies to your embedded players and which applies to your Launchpad. To set the embedded player session settings, go to the "Embed App" section for the app in question (click on the arrow next to the app icon in the Dashboard and select "Embed app"). Then scroll to the bottom of the section where you can select which session settings to apply: [block:image] { "images": [ { "image": [ "https://files.readme.io/ca43ca8-embeddedplayer1.png", "embeddedplayer1.png", 1454, 1068, "#1b1b1b" ] } ] } [/block] Similarly, you can select which session settings to apply to your Launchpad by going to the "Manage Windows App" section in your Launchpad as an admin: [block:image] { "images": [ { "image": [ "https://files.readme.io/1be99f0-c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png", "c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png", 1854, 1208, "#657079" ] } ] } [/block]