{"_id":"57ca18d5edafd80e0007e76f","project":"55d535ca988e130d000b3f5c","__v":1,"parentDoc":null,"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"},"user":"55d535835082980d0009c965","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":"2016-09-03T00:27:01.559Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"Many applications allow users to customize the app interface to suit varying user preferences. For example, default menu locations can be altered based on what workflows are most common for the user. \n\nFrame gives an administrator the ability to configure registries, files and folders on the user's instance to persist across otherwise stateless sessions. At the end of each session, the Frame platform extracts this data (up to 300 MB) and stores it for the user.  Then at the start of their next session, this data is retrieved and inserted on the new instance. This of course, requires that users are authenticated (e.g. will not work for anonymous sessions). \n\nConfiguration of settings and preferences persistence (also called user profile data) is an Advanced Option.  Advanced Options must be turned on for your account by a request to Frame Support and are only available to Frame Platform Ultimate or Frame Enterprise customers. In addition to turning on Advanced Options, you will also need to request turning on the \"enable clearing user profile data\" option.  This will allow an administrator to clear this data for particular users or for all users as needed.\n\nOnce enabled, you can access the feature by going to the account page from the Super Admin view.  Scroll down to the Advanced Options and note the \"Keep profile data config\" field:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8c6c646-Screenshot_2016-09-02_17.11.01.png\",\n        \"Screenshot 2016-09-02 17.11.01.png\",\n        488,\n        296,\n        \"#cacdd1\"\n      ],\n      \"border\": true\n    }\n  ]\n}\n[/block]\nUse the following as a guide for the configuration of the registry keys, files and folders to persist (of course, the actual values will differ depending on what you want to persist) :\n\n[KEYS]\nHKEY_CURRENT_USER\\Software\\abcuserpreferences\n\n[FILES]\nC:\\SOFTWAREABC\\DATA\\Settings.ini\n\n[FOLDERS]\nC:\\SOFTWAREABC\\DATA\\Foldername\n\nYou can also use wildcards in the files section, for example:\n\n[FILES] C:\\SOFTWAREABC\\DATA\\Set*.ini\n\nBe sure to enter the values exactly as shown below (and note that you can add multiple values as additional rows in each section). Note that [FILES], [FOLDERS] and [KEYS] categories are case-sensitive; use only all-caps spelling for this feature. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e082e3d-Screenshot_2016-09-02_17.31.09.png\",\n        \"Screenshot 2016-09-02 17.31.09.png\",\n        446,\n        254,\n        \"#979da2\"\n      ],\n      \"border\": false\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"NOTE THAT APPS MUST USE COLD OR WARM START - Updating application configs and registry values can cause problems when the program is already running, so you cannot use the Hot Start feature.\",\n  \"title\": \"Do not use Hot Start with this feature\"\n}\n[/block]\nNote that as an admin, if you are impersonating a user account with the secure impersonate feature, you will NOT see that users preferences. You can only see these if you have been granted full impersonation rights or if the user gives you their account credentials (e.g. for debugging an issue).\n\nUser profile data can be cleared by going to the user's name in the Team Settings page, and going to the options for that user (gear icon at right side) and clicking on \"Clear profile data.\"\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2d568bb-Screenshot_2016-09-02_17.22.10.png\",\n        \"Screenshot 2016-09-02 17.22.10.png\",\n        201,\n        202,\n        \"#5b6972\"\n      ]\n    }\n  ]\n}\n[/block]\nYou can also clear all users' profile data by clicking this link at the top of the Team Settings page, just under the Search field:  \"Clear All User Profile Data.\"  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d21e08b-Screenshot_2016-09-02_17.25.20.png\",\n        \"Screenshot 2016-09-02 17.25.20.png\",\n        247,\n        151,\n        \"#637683\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Clear user profile data before changing settings\",\n  \"body\": \"If you want to change settings for user profiles, it is best to clear all settings for all users first.\"\n}\n[/block]","excerpt":"Let users save custom settings and preferences for their apps to persist between sessions","slug":"persist-user-preferences","type":"basic","title":"Persist user preferences"}

Persist user preferences

Let users save custom settings and preferences for their apps to persist between sessions

Many applications allow users to customize the app interface to suit varying user preferences. For example, default menu locations can be altered based on what workflows are most common for the user. Frame gives an administrator the ability to configure registries, files and folders on the user's instance to persist across otherwise stateless sessions. At the end of each session, the Frame platform extracts this data (up to 300 MB) and stores it for the user. Then at the start of their next session, this data is retrieved and inserted on the new instance. This of course, requires that users are authenticated (e.g. will not work for anonymous sessions). Configuration of settings and preferences persistence (also called user profile data) is an Advanced Option. Advanced Options must be turned on for your account by a request to Frame Support and are only available to Frame Platform Ultimate or Frame Enterprise customers. In addition to turning on Advanced Options, you will also need to request turning on the "enable clearing user profile data" option. This will allow an administrator to clear this data for particular users or for all users as needed. Once enabled, you can access the feature by going to the account page from the Super Admin view. Scroll down to the Advanced Options and note the "Keep profile data config" field: [block:image] { "images": [ { "image": [ "https://files.readme.io/8c6c646-Screenshot_2016-09-02_17.11.01.png", "Screenshot 2016-09-02 17.11.01.png", 488, 296, "#cacdd1" ], "border": true } ] } [/block] Use the following as a guide for the configuration of the registry keys, files and folders to persist (of course, the actual values will differ depending on what you want to persist) : [KEYS] HKEY_CURRENT_USER\Software\abcuserpreferences [FILES] C:\SOFTWAREABC\DATA\Settings.ini [FOLDERS] C:\SOFTWAREABC\DATA\Foldername You can also use wildcards in the files section, for example: [FILES] C:\SOFTWAREABC\DATA\Set*.ini Be sure to enter the values exactly as shown below (and note that you can add multiple values as additional rows in each section). Note that [FILES], [FOLDERS] and [KEYS] categories are case-sensitive; use only all-caps spelling for this feature. [block:image] { "images": [ { "image": [ "https://files.readme.io/e082e3d-Screenshot_2016-09-02_17.31.09.png", "Screenshot 2016-09-02 17.31.09.png", 446, 254, "#979da2" ], "border": false } ] } [/block] [block:callout] { "type": "warning", "body": "NOTE THAT APPS MUST USE COLD OR WARM START - Updating application configs and registry values can cause problems when the program is already running, so you cannot use the Hot Start feature.", "title": "Do not use Hot Start with this feature" } [/block] Note that as an admin, if you are impersonating a user account with the secure impersonate feature, you will NOT see that users preferences. You can only see these if you have been granted full impersonation rights or if the user gives you their account credentials (e.g. for debugging an issue). User profile data can be cleared by going to the user's name in the Team Settings page, and going to the options for that user (gear icon at right side) and clicking on "Clear profile data." [block:image] { "images": [ { "image": [ "https://files.readme.io/2d568bb-Screenshot_2016-09-02_17.22.10.png", "Screenshot 2016-09-02 17.22.10.png", 201, 202, "#5b6972" ] } ] } [/block] You can also clear all users' profile data by clicking this link at the top of the Team Settings page, just under the Search field: "Clear All User Profile Data." [block:image] { "images": [ { "image": [ "https://files.readme.io/d21e08b-Screenshot_2016-09-02_17.25.20.png", "Screenshot 2016-09-02 17.25.20.png", 247, 151, "#637683" ] } ] } [/block] [block:callout] { "type": "info", "title": "Clear user profile data before changing settings", "body": "If you want to change settings for user profiles, it is best to clear all settings for all users first." } [/block]