{"_id":"5923c772a91ac40f0041e26a","user":"55d535835082980d0009c965","__v":0,"category":{"_id":"55e75b7ae06f4b190080dbff","__v":10,"project":"55d535ca988e130d000b3f5c","version":"55d535cb988e130d000b3f5f","pages":["5637e17197666c0d008656a5","569591a4fcb1032d0089e037","569622eafe18811700c9c19b","5696c9588560a60d00e2c1e0","569709ca0b09a41900b2442b","5697129ac8ded91700307b77","5697190a59a6692d003fad6a","5697192969393517000c8280","569f11908f6d4b0d00f13bb2","56a0030b5b981c2b00383df0"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-02T20:26:34.258Z","from_sync":false,"order":4,"slug":"frame-platform","title":"Frame Platform"},"parentDoc":null,"project":"55d535ca988e130d000b3f5c","version":{"_id":"55d535cb988e130d000b3f5f","__v":12,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-23T05:24:02.813Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"With Frame Platform, you have a number of controls that let you tune exactly how users will experience your application running in a browser. You can set these features using the \"Properties\" of each app and the \"Session Settings.\"\n[block:api-header]\n{\n  \"title\": \"Application Properties\"\n}\n[/block]\nClick on the arrow next to the app icon in the Dashboard and select \"Properties\":\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ab8d3dd-Screen_Shot_2017-04-18_at_6.42.16_PM.png\",\n        \"Screen Shot 2017-04-18 at 6.42.16 PM.png\",\n        185,\n        270,\n        \"#edf0ef\"\n      ]\n    }\n  ]\n}\n[/block]\nHere you can change the title and icon for the application, plus choose a start mode:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/04cec9b-Screen_Shot_2017-05-22_at_10.26.34_PM.png\",\n        \"Screen Shot 2017-05-22 at 10.26.34 PM.png\",\n        1448,\n        958,\n        \"#e4edec\"\n      ]\n    }\n  ]\n}\n[/block]\n* **Start mode:** lets you configure hot start, warm start, or cold start options for an app. This is great for single app use cases, where you want to minimize the time from clicking on an app to running it by pre-launching it in the background before the user connects (hot start).\n\n     - Hot start - the app is started when the host instance boots, and then minimizes. It then waits for a user to request a session. After a session, the app is closed and launched again to be ready for the next user.\n\n     - Warm start - the app is started and then killed when machine boots. This is done to \"warm it  up\". Once you start it once, Windows will cache executables and other binary files in memory, so the next start will be faster.\n\n     - Cold start - the app is started only when someone requests a session with it.\n\n* **Advanced Options:** if you have this option enabled for your account, you can set these on a per-app basis by scrolling down on the App Properties page. This lets you set advanced application parameters and append an app launch path with custom launch arguments/parameters.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a03b350-Screen_Shot_2017-05-22_at_10.34.06_PM.png\",\n        \"Screen Shot 2017-05-22 at 10.34.06 PM.png\",\n        1444,\n        1082,\n        \"#e4edec\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Session Settings\"\n}\n[/block]\nSession Settings give you control over a number of additional features. These can be set the same for all applications that are launched from an embedded player by using the default set of session settings (just as with the Launchpad [described in the Frame for Business section](https://docs.fra.me/v1.0/docs/configure-session-settings)). Or you can set up a unique set of session settings that will apply to each app uniquely. \n\nStart by going to the Session Settings tab in the Settings section of the Dashboard:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/95b47e6-Screen_Shot_2017-05-22_at_9.41.53_PM.png\",\n        \"Screen Shot 2017-05-22 at 9.41.53 PM.png\",\n        2578,\n        956,\n        \"#252728\"\n      ]\n    }\n  ]\n}\n[/block]\nYou can edit the \"Default\" session settings (click on the \"gear\" icon on the right side of the \"Default\" row and select \"Edit\" to access the Session Settings page) or you can create a unique set to be used by one or more embedded players by clicking on \"Add new\" at the top of the list. \n\nOnce on the Session Settings page, you'll see a variety of options that you can configure (you may see more or less options, depending on your tier of Frame Platform):\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6bec042-Screen_Shot_2017-05-22_at_10.50.37_PM.png\",\n        \"Screen Shot 2017-05-22 at 10.50.37 PM.png\",\n        1102,\n        834,\n        \"#638790\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\n* **Collect feedback at session end:** when this feature is enabled, your users are prompted to provide feedback on their experience, which you can review on an ongoing basis in the Analytics section.\n\n* **Collect feedback during session:** lets users access the feedback from the settings menu (gear icon) while running a session.\n\n* **Show distance warning:** pops up a message at session start if the distance to the datacenter is estimated at over 1000 miles.\n\n* **Show Distance Elements:** allows you to disable showing users the distance from their system.  You may want to disable showing this value to users, because it is only an approximation based on the registered location of their IP address.  In some cases, their IP address may be registered in a totally different location from where they are located resulting a false distance measurement.  The best measure of performance is the latency and should be the primary focus for an end user.  \n\n* **Enable custom session limits:** allows you to configure custom inactivity timeout, idle timeout and max session duration settings for applications using the embedded player that override the general settings for the account. \n\n* **Show latency measure:** allows you to control whether or not the latency indicator in the session status bar is shown.\n\n* **Enable microphone:** lets you control whether you want audio input enabled when using apps that have this set of session settings applied.\n\n* **Enable mouse mode selection:** for use cases that require special mouse modes, you can expose these modes via a mouse icon in the session status bar.\n\nScroll down for even more session settings:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e75b07e-Screen_Shot_2017-05-22_at_10.58.51_PM.png\",\n        \"Screen Shot 2017-05-22 at 10.58.51 PM.png\",\n        1440,\n        1090,\n        \"#5a828a\"\n      ]\n    }\n  ]\n}\n[/block]\n* **Resolution:** lets you select fixed screen resolutions instead of the default dynamic scaling option. This also lets you choose which options you want to make visible to users from within their session.\n\n* **Custom Dialogs:** configure custom pop-up messages at the start of a session:\n\n     - Show disclaimer - a pop-up that requires acknowledgment, like your terms of service.\n\n     - Show tips - custom information that you want to show to each user on start.\n\n     - Prompt user about low resolution - if your app requires a minimum resolution to display properly, and the user starts with a browser window that is too small, you can warn them.\n\n     - Use custom feedback content -  you can use your own custom content for the feedback option at the end of session. \n\n     - Show about dialog - you can choose to show or not show the About dialog that a user can access from within their session (from the \"gear\" menu).\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/9afa500-Screen_Shot_2017-05-30_at_10.28.47_PM.png\",\n        \"Screen Shot 2017-05-30 at 10.28.47 PM.png\",\n        1454,\n        1068,\n        \"#1b1b1b\"\n      ],\n      \"border\": true\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/c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png\",\n        \"Screen Shot 2017-05-30 at 10.30.42 PM.png\",\n        1854,\n        1208,\n        \"#617077\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Control your end users' experience with custom session settings","slug":"set-custom-app-properties-new","type":"basic","title":"Set custom app properties - New!"}

Set custom app properties - New!

Control your end users' experience with custom session settings

With Frame Platform, you have a number of controls that let you tune exactly how users will experience your application running in a browser. You can set these features using the "Properties" of each app and the "Session Settings." [block:api-header] { "title": "Application Properties" } [/block] Click on the arrow next to the app icon in the Dashboard and select "Properties": [block:image] { "images": [ { "image": [ "https://files.readme.io/ab8d3dd-Screen_Shot_2017-04-18_at_6.42.16_PM.png", "Screen Shot 2017-04-18 at 6.42.16 PM.png", 185, 270, "#edf0ef" ] } ] } [/block] Here you can change the title and icon for the application, plus choose a start mode: [block:image] { "images": [ { "image": [ "https://files.readme.io/04cec9b-Screen_Shot_2017-05-22_at_10.26.34_PM.png", "Screen Shot 2017-05-22 at 10.26.34 PM.png", 1448, 958, "#e4edec" ] } ] } [/block] * **Start mode:** lets you configure hot start, warm start, or cold start options for an app. This is great for single app use cases, where you want to minimize the time from clicking on an app to running it by pre-launching it in the background before the user connects (hot start). - Hot start - the app is started when the host instance boots, and then minimizes. It then waits for a user to request a session. After a session, the app is closed and launched again to be ready for the next user. - Warm start - the app is started and then killed when machine boots. This is done to "warm it up". Once you start it once, Windows will cache executables and other binary files in memory, so the next start will be faster. - Cold start - the app is started only when someone requests a session with it. * **Advanced Options:** if you have this option enabled for your account, you can set these on a per-app basis by scrolling down on the App Properties page. This lets you set advanced application parameters and append an app launch path with custom launch arguments/parameters. [block:image] { "images": [ { "image": [ "https://files.readme.io/a03b350-Screen_Shot_2017-05-22_at_10.34.06_PM.png", "Screen Shot 2017-05-22 at 10.34.06 PM.png", 1444, 1082, "#e4edec" ], "border": true } ] } [/block] [block:api-header] { "title": "Session Settings" } [/block] Session Settings give you control over a number of additional features. These can be set the same for all applications that are launched from an embedded player by using the default set of session settings (just as with the Launchpad [described in the Frame for Business section](https://docs.fra.me/v1.0/docs/configure-session-settings)). Or you can set up a unique set of session settings that will apply to each app uniquely. Start by going to the Session Settings tab in the Settings section of the Dashboard: [block:image] { "images": [ { "image": [ "https://files.readme.io/95b47e6-Screen_Shot_2017-05-22_at_9.41.53_PM.png", "Screen Shot 2017-05-22 at 9.41.53 PM.png", 2578, 956, "#252728" ] } ] } [/block] You can edit the "Default" session settings (click on the "gear" icon on the right side of the "Default" row and select "Edit" to access the Session Settings page) or you can create a unique set to be used by one or more embedded players by clicking on "Add new" at the top of the list. Once on the Session Settings page, you'll see a variety of options that you can configure (you may see more or less options, depending on your tier of Frame Platform): [block:image] { "images": [ { "image": [ "https://files.readme.io/6bec042-Screen_Shot_2017-05-22_at_10.50.37_PM.png", "Screen Shot 2017-05-22 at 10.50.37 PM.png", 1102, 834, "#638790" ], "border": true } ] } [/block] * **Collect feedback at session end:** when this feature is enabled, your users are prompted to provide feedback on their experience, which you can review on an ongoing basis in the Analytics section. * **Collect feedback during session:** lets users access the feedback from the settings menu (gear icon) while running a session. * **Show distance warning:** pops up a message at session start if the distance to the datacenter is estimated at over 1000 miles. * **Show Distance Elements:** allows you to disable showing users the distance from their system. You may want to disable showing this value to users, because it is only an approximation based on the registered location of their IP address. In some cases, their IP address may be registered in a totally different location from where they are located resulting a false distance measurement. The best measure of performance is the latency and should be the primary focus for an end user. * **Enable custom session limits:** allows you to configure custom inactivity timeout, idle timeout and max session duration settings for applications using the embedded player that override the general settings for the account. * **Show latency measure:** allows you to control whether or not the latency indicator in the session status bar is shown. * **Enable microphone:** lets you control whether you want audio input enabled when using apps that have this set of session settings applied. * **Enable mouse mode selection:** for use cases that require special mouse modes, you can expose these modes via a mouse icon in the session status bar. Scroll down for even more session settings: [block:image] { "images": [ { "image": [ "https://files.readme.io/e75b07e-Screen_Shot_2017-05-22_at_10.58.51_PM.png", "Screen Shot 2017-05-22 at 10.58.51 PM.png", 1440, 1090, "#5a828a" ] } ] } [/block] * **Resolution:** lets you select fixed screen resolutions instead of the default dynamic scaling option. This also lets you choose which options you want to make visible to users from within their session. * **Custom Dialogs:** configure custom pop-up messages at the start of a session: - Show disclaimer - a pop-up that requires acknowledgment, like your terms of service. - Show tips - custom information that you want to show to each user on start. - Prompt user about low resolution - if your app requires a minimum resolution to display properly, and the user starts with a browser window that is too small, you can warn them. - Use custom feedback content - you can use your own custom content for the feedback option at the end of session. - Show about dialog - you can choose to show or not show the About dialog that a user can access from within their session (from the "gear" menu). [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/9afa500-Screen_Shot_2017-05-30_at_10.28.47_PM.png", "Screen Shot 2017-05-30 at 10.28.47 PM.png", 1454, 1068, "#1b1b1b" ], "border": true } ] } [/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/c270164-Screen_Shot_2017-05-30_at_10.30.42_PM.png", "Screen Shot 2017-05-30 at 10.30.42 PM.png", 1854, 1208, "#617077" ] } ] } [/block]