{"_id":"58123ed8bb6a680f00f3c29f","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"},"project":"55d535ca988e130d000b3f5c","__v":0,"parentDoc":null,"user":"57ebf6b80db1190e0094a3ba","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-10-27T17:52:24.950Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":17,"body":"How do you know if a user is going to have a great experience on Frame? The performance of their sessions depends on how good their network connection is and how far they are from the data center. With the customizable connection check page, you can give your users a quick way to test their network, find which data center would be best for them, and even check that their browser is compatible and supports Websockets.\n\nThe connection check page is included with Frame for Business and Frame Platform and can be customized with your organization's branding. You can set up the page with a custom background, logo, header, and footer as well as choose which data centers to test. With the custom header/footer you can even insert a link to additional documentation or to another workflow. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Enabling and configuring the connection check page\"\n}\n[/block]\nFirst, email us at support:::at:::fra.me, to request enabling this feature on your account. \n\nAfter receiving the confirmation email from our support team, login to your Frame account and click the drop down arrow on the top left side of the page: \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1ebd7bb-dropdown1.jpg\",\n        \"dropdown1.jpg\",\n        450,\n        277,\n        \"#2b4e71\"\n      ]\n    }\n  ]\n}\n[/block]\nClick “Customize check page.”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/26bcf32-Screen_Shot_2017-05-16_at_6.28.24_PM.png\",\n        \"Screen Shot 2017-05-16 at 6.28.24 PM.png\",\n        217,\n        388,\n        \"#d5d6d6\"\n      ]\n    }\n  ]\n}\n[/block]\nFrom here, you will be taken to the customization page where you can set your own background, logo, header, footer, and page title. For the header and footer you can insert basic HTML to insert links and other web elements.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c7eafc2-checkpagecustomization.jpg\",\n        \"checkpagecustomization.jpg\",\n        925,\n        838,\n        \"#49657f\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nEnable the connection check page by moving the “Check page enabled” slider to the right. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8497396-checkpageenabled.jpg\",\n        \"checkpageenabled.jpg\",\n        490,\n        210,\n        \"#30557a\"\n      ]\n    }\n  ]\n}\n[/block]\nSelect which locations you would like to test for bandwidth and latency. You can also drag and drop locations to change the order in which they appear.  \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/58b96fc-locations.jpg\",\n        \"locations.jpg\",\n        235,\n        428,\n        \"#6a8195\"\n      ]\n    }\n  ]\n}\n[/block]\nWhen you have changed your desired settings, click “APPLY.”\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9965ea2-apply.jpg\",\n        \"apply.jpg\",\n        520,\n        216,\n        \"#2f587d\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Testing and sharing the test page URL\"\n}\n[/block]\nYou can preview your connection check page by clicking “PREVIEW” at the top of the page. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4fae712-preview.jpg\",\n        \"preview.jpg\",\n        520,\n        216,\n        \"#2f587d\"\n      ]\n    }\n  ]\n}\n[/block]\nA separate tab will open up in your browser, displaying a preview of your connection check test page.\n\nTo share the test page with your users, copy the URL in your preview tab and distribute it however you like (email, instant message, etc.). Your check page is now live and accessible to anyone without logging into Frame. \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2b06632-check-page-sample-pic.png\",\n        \"check-page-sample-pic.png\",\n        2044,\n        1714,\n        \"#505e6a\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Interpreting test results\",\n  \"body\": \"If latency is less than 100 ms, users will see a white check mark.  If the result is more than 100 ms, a red X will be shown. However, note that this does not mean the connection will not work, just that the experience will not be the best.  Similarly, the bandwidth test results will be color coded to show relative performance. \\n\\nNote that since network conditions are always changing, you should encourage your users to run the test a few times to see how consistent (or inconsistent) their network is. You can do this by adding text to the header or footer (e.g. \\\"Please run this test five times to see how your network is changing\\\").\"\n}\n[/block]","excerpt":"Give users a quick way to test their network and compatibility with Frame","slug":"connection-check-page","type":"basic","title":"Connection check page"}

Connection check page

Give users a quick way to test their network and compatibility with Frame

How do you know if a user is going to have a great experience on Frame? The performance of their sessions depends on how good their network connection is and how far they are from the data center. With the customizable connection check page, you can give your users a quick way to test their network, find which data center would be best for them, and even check that their browser is compatible and supports Websockets. The connection check page is included with Frame for Business and Frame Platform and can be customized with your organization's branding. You can set up the page with a custom background, logo, header, and footer as well as choose which data centers to test. With the custom header/footer you can even insert a link to additional documentation or to another workflow. [block:api-header] { "type": "basic", "title": "1. Enabling and configuring the connection check page" } [/block] First, email us at support@fra.me, to request enabling this feature on your account. After receiving the confirmation email from our support team, login to your Frame account and click the drop down arrow on the top left side of the page: [block:image] { "images": [ { "image": [ "https://files.readme.io/1ebd7bb-dropdown1.jpg", "dropdown1.jpg", 450, 277, "#2b4e71" ] } ] } [/block] Click “Customize check page.” [block:image] { "images": [ { "image": [ "https://files.readme.io/26bcf32-Screen_Shot_2017-05-16_at_6.28.24_PM.png", "Screen Shot 2017-05-16 at 6.28.24 PM.png", 217, 388, "#d5d6d6" ] } ] } [/block] From here, you will be taken to the customization page where you can set your own background, logo, header, footer, and page title. For the header and footer you can insert basic HTML to insert links and other web elements. [block:image] { "images": [ { "image": [ "https://files.readme.io/c7eafc2-checkpagecustomization.jpg", "checkpagecustomization.jpg", 925, 838, "#49657f" ], "sizing": "full" } ] } [/block] Enable the connection check page by moving the “Check page enabled” slider to the right. [block:image] { "images": [ { "image": [ "https://files.readme.io/8497396-checkpageenabled.jpg", "checkpageenabled.jpg", 490, 210, "#30557a" ] } ] } [/block] Select which locations you would like to test for bandwidth and latency. You can also drag and drop locations to change the order in which they appear. [block:image] { "images": [ { "image": [ "https://files.readme.io/58b96fc-locations.jpg", "locations.jpg", 235, 428, "#6a8195" ] } ] } [/block] When you have changed your desired settings, click “APPLY.” [block:image] { "images": [ { "image": [ "https://files.readme.io/9965ea2-apply.jpg", "apply.jpg", 520, 216, "#2f587d" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Testing and sharing the test page URL" } [/block] You can preview your connection check page by clicking “PREVIEW” at the top of the page. [block:image] { "images": [ { "image": [ "https://files.readme.io/4fae712-preview.jpg", "preview.jpg", 520, 216, "#2f587d" ] } ] } [/block] A separate tab will open up in your browser, displaying a preview of your connection check test page. To share the test page with your users, copy the URL in your preview tab and distribute it however you like (email, instant message, etc.). Your check page is now live and accessible to anyone without logging into Frame. [block:image] { "images": [ { "image": [ "https://files.readme.io/2b06632-check-page-sample-pic.png", "check-page-sample-pic.png", 2044, 1714, "#505e6a" ] } ] } [/block] [block:callout] { "type": "warning", "title": "Interpreting test results", "body": "If latency is less than 100 ms, users will see a white check mark. If the result is more than 100 ms, a red X will be shown. However, note that this does not mean the connection will not work, just that the experience will not be the best. Similarly, the bandwidth test results will be color coded to show relative performance. \n\nNote that since network conditions are always changing, you should encourage your users to run the test a few times to see how consistent (or inconsistent) their network is. You can do this by adding text to the header or footer (e.g. \"Please run this test five times to see how your network is changing\")." } [/block]