Total Living Choices (TLC) Web Application Embedding and Implementation Manual

Transcription

1 Total Living Choices (TLC) Web Application Embedding and Implementation Manual July 15, 2009 Rev

2 Overview This document explains the general requirements and guidelines for embedding TLChoices web applications (WAs) onto your web site. You will see that the work required on your end will be minimal from a technical standpoint. You will not need to host any new applications, hardware or software as a result of adding a WA. Specific details (i.e. what page to launch the WA from, what the header should look like, what links should be used, etc.) will vary from Partner to Partner. We recommend discussing an implementation strategy before developing these embedding elements. General Flow Partners who add a single WA to their site typically link to the WA from one or more appropriate locations on their site. The link(s) exist on the Partner server just like their other web pages and will serve as a launching point to their embedded WA. The WA itself will exist on TLC servers with the Partner header and footer. Three decisions that Partners will need to make Adding the WA requires answers to these three questions: 1. What will your header and footer look like on the WA? 2. What will your Jump Page(s) look like and where will it/they live on your site? (A simple link may be more appropriate in certain cases, e.g. embedding Care Finder Pro on an intranet-only website.) 3. To what page will the user return when exiting a WA? TLC can have a Project Manager provide ideas and mock-ups to help you with these decisions. How long does the embedding process take? Once the header/footer and associated items are received and approved by our Development Team, and a contract is signed, it will take up to 30 days for the embedded WA to launch on TLC s servers, making them available for you to link to (this could depend on any number of variables, such as agreed-upon implementation schedule, internal TLC maintenance schedules, Partner responsiveness to questions that arise during implementation, etc.). Any customizations to the WA could potentially add to this 30-day window, depending on complexity. We will notify you when your WA URL(s) are active on our servers for you to view and link to them from your site. If you have any further questions about this document, please contact us at: embedding@tlchoices.com Rev

3 Embedding Browser Partner Web Servers Overview Partner Web Page Web Application Front Page TLChoices Web Application Servers Requirements Rev

4 The following table outlines the web browser requirements for each of TLC s webready services. Cells with an x are compatible application/browser combinations. At this time, all TLC s web applications require both JavaScript and cookies to be enabled in the user s browser. Care Finder Pro Care Interpreter Facility Finder Parkinson s Educator Cookies JavaScript IE 4 IE 5.x IE 6+ NS 4.x NS 6+ Opera X X X X X X X X X X X X X X X X X X X X X X X Audience Hospital discharge coordinators (in office) Home users Home users Home users, paraprofessional caregivers Browser Requirements Table Rev

5 Custom Templates By using custom header, footer and navigation elements, your existing web site is cosmetically reproduced on TLC s servers. Visitors to your web site who follow a link from your site to one of TLC s services will experience a seamless transition, making it appear that TLC s services are an integrated part of your site. Users will also be able to navigate back into your site using any navigation elements included in your custom site template. Your Site Header Your Site Sidebar (optional) TLChoices Generated Content Custom JavaScript Files Custom CSS Files Custom Image Files Your Site Footer TLC Embedding Template In order to embed TLC s web applications in your website, TLC requires the following pieces of custom content: Custom header HTML fragment Custom footer HTML fragment Custom sidebar HTML fragment (optional, not used on all TLC pages) Custom JavaScript files, if any Custom CSS files, if any Custom image files Rev

6 Requirements for HTML Fragments: Character limit: 7000 characters per area (header, footer, etc.) is the limit. ASP: We are not able to accept ASP or other server-side script in the header/footer/sidebar code at this time, because our embedding architecture does not interpret any server side code. Converting relative URLs: All relative URL references in the HTML which should direct users back to your existing site must first be converted to absolute URLs pointing to your website. For example, <a href= /default.asp >Home</a> should be changed to <a href= >Home</a> Preserving mirrored URLs: Do not convert relative URLs for items which will be mirrored on TLC servers, such as custom images, CSS or JavaScript files which you deliver with your HTML fragments. TLC will properly adjust these URLs on our end. JavaScript considerations: All JavaScript that references forms should do so by name and not index number. For example: document.address.zipcode (PREFERRED) document.forms[1].zipcode (NOT PREFERRED) While it is also possible to embed TLC s generated content in a frame, this is strongly discouraged due to browser-security restrictions, which can unpredictably prohibit some users from viewing the TLC-generated frame. Rev