{"_id":"5923c772a91ac40f0041e26a","user":"55d535835082980d0009c965","__v":1,"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"},"githubsync":"","parentDoc":null,"project":"55d535ca988e130d000b3f5c","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"},"updates":["59e13912a7c18b001afa4005"],"next":{"pages":[],"description":""},"createdAt":"2017-05-23T05:24:02.813Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"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 as well as 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/cd0072b-startmode.png\",\n        \"startmode.png\",\n        690,\n        286,\n        \"#c0ccd2\"\n      ]\n    }\n  ]\n}\n[/block]\n### Start mode: \nLets 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). These modes require the \"quick connect\" toggle to be enabled by Frame support. \n\n**Note: Start mode can only be modified on Production applications. To modify start mode, you must navigate to the Production tab on your Dashboard**\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 terminated when the machine boots. This is done to \"warm it up\". The first time you start the app, 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: \nIf 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. We'll review each field below. \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+ **App launch path:**\nThis path is automatically obtained when the application is Onboarded and can be modified by the account administrator. An admin may want to modify the launch path if they are onboarding two different versions of the same application and want both versions available from the Launchpad.\n\n+ **App launch arguments: **\nAn app launch argument is a variable required for your application to start in a specified manner. These arguments are typically listed next to the application's command line for the shortcut in a regular Windows environment. Putting any app launch arguments under Application settings ensures that the launch argument will still work if you launch it as a secondary app from an existing session.\n\n+ **Working directory:**\nThis is where you define the path that your application will be working from. If you have applications that need to search a directory for files, you will want to specify a working directory so the application knows where to search. This also specifies the default directory being opened when browsing files from the application. By default, the directory of the application used to launch a session is the working directory for the entire session.  Specifying a working directory here ensures that the working directory for the application is correct even if launched as a secondary app in an existing session.\n\n+ **Application ID:**\nA unique ID that is automatically assigned to your application when onboarded. \n\n#### Example:\nIn the example below, we’ve numbered the 3 available fields and the fields they correspond to within the session. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1ff7bb0-advancedoptionsedited.png\",\n        \"advancedoptionsedited.png\",\n        734,\n        762,\n        \"#e3e9ea\"\n      ]\n    }\n  ]\n}\n[/block]\n**1.** In Windows, the app launch path is the equivalent of the Target path in the shortcut’s properties window. \n\n**2.** Normally, any launch arguments would be appended to the “Target” path in the shortcut’s properties. Notepad will always launch the specified file when accessing this shortcut. The same is true when launching the application from Frame’s Launchpad or from within the session with the advanced options listed above. \n\n**3.** The working directory is the same as the “Start in” path specified in the Windows shortcut.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/73f0d54-advancedsettingsedited.png\",\n        \"advancedsettingsedited.png\",\n        379,\n        519,\n        \"#e6e4e8\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Session Settings\",\n  \"body\": \"You can customize many aspects of the way your users' sessions will behave by editing \\\"Session Settings.\\\" 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. If you would like to read more, please reference the documentation in Frame for Business [here](https://docs.fra.me/docs/configure-session-settings).\"\n}\n[/block]","excerpt":"Control your end users' experience with custom session settings","slug":"set-custom-app-properties","type":"basic","title":"Set custom application properties"}

Set custom application properties

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 as well as 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/cd0072b-startmode.png", "startmode.png", 690, 286, "#c0ccd2" ] } ] } [/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). These modes require the "quick connect" toggle to be enabled by Frame support. **Note: Start mode can only be modified on Production applications. To modify start mode, you must navigate to the Production tab on your Dashboard** - 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 terminated when the machine boots. This is done to "warm it up". The first time you start the app, 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. We'll review each field below. [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] + **App launch path:** This path is automatically obtained when the application is Onboarded and can be modified by the account administrator. An admin may want to modify the launch path if they are onboarding two different versions of the same application and want both versions available from the Launchpad. + **App launch arguments: ** An app launch argument is a variable required for your application to start in a specified manner. These arguments are typically listed next to the application's command line for the shortcut in a regular Windows environment. Putting any app launch arguments under Application settings ensures that the launch argument will still work if you launch it as a secondary app from an existing session. + **Working directory:** This is where you define the path that your application will be working from. If you have applications that need to search a directory for files, you will want to specify a working directory so the application knows where to search. This also specifies the default directory being opened when browsing files from the application. By default, the directory of the application used to launch a session is the working directory for the entire session. Specifying a working directory here ensures that the working directory for the application is correct even if launched as a secondary app in an existing session. + **Application ID:** A unique ID that is automatically assigned to your application when onboarded. #### Example: In the example below, we’ve numbered the 3 available fields and the fields they correspond to within the session. [block:image] { "images": [ { "image": [ "https://files.readme.io/1ff7bb0-advancedoptionsedited.png", "advancedoptionsedited.png", 734, 762, "#e3e9ea" ] } ] } [/block] **1.** In Windows, the app launch path is the equivalent of the Target path in the shortcut’s properties window. **2.** Normally, any launch arguments would be appended to the “Target” path in the shortcut’s properties. Notepad will always launch the specified file when accessing this shortcut. The same is true when launching the application from Frame’s Launchpad or from within the session with the advanced options listed above. **3.** The working directory is the same as the “Start in” path specified in the Windows shortcut. [block:image] { "images": [ { "image": [ "https://files.readme.io/73f0d54-advancedsettingsedited.png", "advancedsettingsedited.png", 379, 519, "#e6e4e8" ] } ] } [/block] [block:callout] { "type": "info", "title": "Session Settings", "body": "You can customize many aspects of the way your users' sessions will behave by editing \"Session Settings.\" 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. If you would like to read more, please reference the documentation in Frame for Business [here](https://docs.fra.me/docs/configure-session-settings)." } [/block]