LiveTiles v.3.0 Installation Guide

Size: px

Start display at page:

Download "LiveTiles v.3.0 Installation Guide"

Antony Webb
6 years ago
Views:

1 LiveTiles v.3.0 Installatin Guide Versin: 1.0

2 Versin Histry Versin Number Cmments 1.0 Published versin n release. LiveTiles V3 Installatin Guide V1.0 1

3 Cntents 1 Installing LiveTiles Befre yu begin Install Steps Preparing t use LiveTiles Register yur licence key Add Users t LiveTiles Grup Set Brwser Security Settings fr LiveTiles Upgrading LiveTiles Uninstall LiveTiles frm SharePint Preparatin Uninstall LiveTiles frm SharePint What t d if installatin fails Failure when Activating Slutin Appendix Features Created by LiveTiles Sub Site Created by LiveTiles Settings Cnfigured by LiveTiles Lists and Libraries Created by LiveTiles LiveTiles V3 Installatin Guide V1.0 2

4 1 Installing LiveTiles This guide assumes the reader has a level f SharePint knwledge in relatin t Site Cllectins, SharePint security management, the Slutin Gallery, and Site Feature management. LiveTiles v.3.0 is fr installatin int SharePint nline fr Office 365 r SharePint Server 2013 (n premise). 1.1 Befre yu begin Befre attempting the installatin f LiveTiles, there are several steps which need t be taken: Obtain the LiveTiles installatin package. The installatin package is based n a sandbxed slutin (.WSP). The same package is used fr n premise and Office 365 deplyment. If yu are using SharePint On-Premise, please make sure the Micrsft SharePint Fundatin Sandbxed Cde Service is started: Lgin t Central Administratin prtal f SharePint 2013 On-Premise by using an administratr accunt. G t Manage services in this farm which is a link in the System Settings sectin, as the fllwing screensht indicates: Find and click yur server name in the list. Make sure Micrsft SharePint Fundatin Sandbxed Cde Service is activated. 1.2 Install Steps Fllw these step-by-step instructins t install LiveTiles n SharePint 2013: 1. Lgin t yur SharePint site: a. Please make sure yur accunt has full permissin t site cllectin yu lgged in t. b. The minimum permissin requirement is Site Cllectin Administratr t the site cllectin. 2. Navigate t the SharePint Site Settings page. LiveTiles V3 Installatin Guide V1.0 3

3. Navigate t Slutins by selecting Slutin in the Web Designer Galleries sectin 4. Uplad the installatin package by clicking Uplad Slutin n the tp left.

Activate LiveTiles by clicking Activate in the pp up windw. 6. Wait fr the slutin t activate.

5 3. Navigate t Slutins by selecting Slutin in the Web Designer Galleries sectin 4. Uplad the installatin package by clicking Uplad Slutin n the tp left. Next, click Brwse and select the install package. Click OK t start uplading. NB: The time required fr uplading will depended n yur netwrk envirnment. 5. Activate LiveTiles by clicking Activate in the pp up windw. 6. Wait fr the slutin t activate. This prcess shuld take up t 5-10 minutes, depending n the current lad n yur envirnment. Please wait until the activatin is finished r failed - if there is an errr reprted r there is n activity in a lng time, visit Sectin 5 fr the next step. LiveTiles V3 Installatin Guide V1.0 4

6 After the slutin is activated, yur installatin is cmpleted. The fllwing steps can nw verify whether the installatin has been successful: 1. G t SharePint s Site Settings at the rt site level and select Site cllectin features under the Site Cllectin Administratin area: 2. Yu shuld see a number f LiveTiles features, all labeled as active. If sme are displaying as ntactive yu can manually activate them by hitting Activate n the right side. (refer t Sectin 6.1 fr a detailed list). NB: If yu are using SharePint Online, the feature icns will nt be displayed unless yu refresh the page.. 3. If all the features in the list shw as Active, yur LiveTiles installatin has been successful. LiveTiles V3 Installatin Guide V1.0 5

7 2 Preparing t use LiveTiles This sectin details a list f activities t be undertaken befre using LiveTiles. 2.1 Register yur licence key Befre yu can design pages with LiveTiles yu must register and activate yur licence key. Fr new installatins this ccurs when yu try t create yur first LiveTiles page. Fr upgrades the license check will ccur when yu enter design mde n any existing LiveTiles page r create a new page (Nte: the license check des nt ccur n existing page viewing). When the license check detects a missing r expired license key the fllwing message is displayed: License check message Clicking N will take yu back t the read nly mde f the page. Clicking Yes will redirect yu t the license registratin page: Initial registratin lading message LiveTiles V3 Installatin Guide V1.0 6

8 License registratin frm Once the license registratin frm appears, yu need t enter yur license key (as prvided by yur LiveTiles partner r directly frm LiveTiles) and cntact details. A link t ur End User license agreement is available n the frm. Yu will need t agree t its terms befre yu can prceed with registratin. Click the Register buttn t register yur license. Cmpleted registratin infrmatin LiveTiles V3 Installatin Guide V1.0 7

License registratin successful message Once registered yu will nt be prmpted again fr yur license until yur license expiry date is reached (please refer t yur purchase agreement fr the details f yur

9 License registratin successful message Once registered yu will nt be prmpted again fr yur license until yur license expiry date is reached (please refer t yur purchase agreement fr the details f yur license term). Nte: Any new installatins f LiveTiles int ther site cllectins within yur envirnment will require registratin. The same license key is used fr these additinal installatins, unless yu request r are prvided with a separate license agreement. 2.2 Add Users t LiveTiles Grup The LiveTiles installatin prcess will create a SharePint security grup called LiveTiles Owners. This grup cntrls wh has the ability t design LiveTiles pages. Any users wh will be using LiveTiles fr page design must be added t this grup. T d this: 1. G t SharePint Site Settings at the rt site level 2. Select Peple and grups under the Users and Permissins area: 3. On the left hand side navigatin menu click Grups: LiveTiles V3 Installatin Guide V1.0 8

10 4. Select LiveTiles Owners frm the list f available grups: 5. Add the users t the grup. Nte: it is a requirement fr the accunts t be added as individual user accunts. 2.3 Set Brwser Security Settings fr LiveTiles If yu are using Office 365, r yu run SharePint ver HTTPs, yu may cntinuusly receive Shw All Cntent prmpts n the pages f yur Internet Explrer (IE) brwser. This is due t the fact that sme example cntent cmes frm a surces based n HTTP (fr example the sample RSS feed), which will be recgnized as unsafe in sme brwsers. Yu can take the fllwing steps t reslve this: Make the site as a trusted site in IE: Open IE brwser Click n the tls icn and select Internet Optins Click n the Security tab and click Trusted sites under select zne then hit Sites buttn Type in the URL address f yur intranet site then hit buttn Add Clse the windw and click OK Restart IE and launch a fresh page Then allw mixed cntent in IE: Open IE Click n the tls icn and select Internet Optins Click n the Security tab and click n Custm level Under Settings g t Miscellaneus and Enable Display Mixed Cntent Click OK Restart Internet Explrer and check t see if it displays the pp-up LiveTiles V3 Installatin Guide V1.0 9

11 3 Upgrading LiveTiles This sectin details the prcess fr upgrading an existing installatin f LiveTiles. The upgrade prcess is the same as the initial installatin prcess ther than the final step being Upgrade rather than Activate: 1. Obtain new versin f installatin package 2. Uplad t Slutins Gallery 3. Select new package frm the gallery list 4. Click Upgrade n the new package The previus versin f LiveTiles will be autmatically deactivated as part f the upgrade prcess. Nte: smetimes it will be necessary fr existing pages t g thrugh an upgrade step themselves nce the new versin has been activated. This is mst likely t ccur with majr prduct releases that intrduce significant changes t the page cde structure. If this is required the steps required will be dcumented in the accmpanying release ntes fr the new versin Once yu have upgraded t versin 3 please refer t the Register yur licence key sectin. LiveTiles V3 Installatin Guide V1.0 10

It is imprtant t cnfirm that these sites r pages are n lnger required. Nte: nn-livetiles pages (i.e. standard SharePint pages) are nt impacted by the uninstall.

12 4 Uninstall LiveTiles frm SharePint This sectin details the uninstall prcess. 4.1 Preparatin Befre attempting t uninstall LiveTiles, sme preparatin may be required: Uninstalling LiveTiles will affect any pages built by LiveTiles. It is imprtant t cnfirm that these sites r pages are n lnger required. Nte: nn-livetiles pages (i.e. standard SharePint pages) are nt impacted by the uninstall. Uninstalling LiveTiles will delete the whle sub site ( LiveTiles ) created by the LiveTiles installatin. It is imprtant t cnfirm that there is n ther cntent except LiveTiles saved in this sub site. 4.2 Uninstall LiveTiles frm SharePint Lgin t yur SharePint site: a. The minimum permissin requirement is Site Cllectin Administratr t the target site r site cllectin. 2. Navigate t SharePint s Site Settings 3. Click Slutins under the Web Designer Galleries sectin: 4. Select the LiveTiles slutin package by ticking the bx in frnt LiveTiles. Nte: The check bx will nt display unless yu mve yur cursr t the frnt f the slutin item. LiveTiles V3 Installatin Guide V1.0 11

5. Deactivate LiveTiles by clicking Deactivate in the tp navigatin and selecting Deactivate in the mdal pp up windw. 6. Wait fr deactivatin t cmplete. This prcess may take a few minutes. 7.

13 5. Deactivate LiveTiles by clicking Deactivate in the tp navigatin and selecting Deactivate in the mdal pp up windw. 6. Wait fr deactivatin t cmplete. This prcess may take a few minutes. 7. After deactivatin is cmplete, the status fr the LiveTiles slutin will be empty. With the uninstallatin prcess finished, the fllwing steps can nw verify whether it was successful. 8. Gt t SharePint s Site Settings at the rt site level. 9. G t Site cllectin features by clicking Site cllectin features under the Site Cllectin Administratin sectin: 10. There shuld be n features beginning with LiveTiles in the list. This cnfirms the uninstallatin has been successful. LiveTiles V3 Installatin Guide V1.0 12

14 5 What t d if installatin fails This sectin will detail the steps t undertake in the event f unfreseen issues with installing LiveTiles. 5.1 Failure when Activating Slutin In sme cases, the activatin fr LiveTiles may be unsuccessful. Cmmn causes fr this are issues with the sandbx cde service in n premise installatins r an install time ut n the envirnment, which may be as a result f the envirnment being under heavy lad. After this errr has ccurred, the slutin may be displayed as Activate, hwever n cntent is activated fr LiveTiles. In this event, fllw these instructins step-by-step and yu can activate LiveTiles manually: 1. G t SharePint s Site Settings at the rt site level 2. G t Site cllectin features under the Site Cllectin Administratin sectin: 3. Yu will nw see a list f features beginning with LiveTiles as the shwn in the fllwing screensht. (Please visit Sectin 6.1 fr a detailed list). 4. These features are nt activated. Hwever, if sme are shwing the Activate status, please deactivate them first. LiveTiles V3 Installatin Guide V1.0 13

15 5. Nw, activate all the features ne-by-ne, in sequential rder, starting at the tp with LiveTiles. 6. After all features have been manually activated, yur installatin shuld wrk as expected. It is als pssible t deactivate the slutin package as per the instructins in Sectin 4 and retry the installatin. LiveTiles V3 Installatin Guide V1.0 14

16 6 Appendix This sectin includes further details which will help yu t use LiveTiles. 6.1 Features Created by LiveTiles LiveTiles creates a number f site cllectin features in the target site cllectin. These features setup the required infrmatin architecture fr the LiveTiles installatin as well as ppulate lists and libraries with cntent. The fllwing is a list f these features: LiveTiles LiveTiles App Icns LiveTiles App Icns fr Templates LiveTiles Backgrunds LiveTiles MasterPage LiveTiles My App Icns LiveTiles My Apps Gallery LiveTiles Page Icns LiveTiles Page Templates LiveTiles Publishing Images LiveTiles Sample Image LiveTiles Sample Lists LiveTiles Site Pages LiveTiles SiteAsset LiveTiles Tile Gallery LiveTiles Tile Icns A LiveTiles Tile Icns B LiveTiles Tile Icns C LiveTiles Tile Icns D LiveTiles Tile Images 6.2 Sub Site Created by LiveTiles LiveTiles will create ne sub site under the rt site, called LiveTiles. This sub site cntains all the files and data cntained in LiveTiles. IMPORTANT NOTE: If this sub site is deleted, LiveTiles will n lnger functin prperly. N files within the Site Assets library (such as CSS and JS files shuld be changed. LiveTiles V3 Installatin Guide V1.0 15

17 6.3 Settings Cnfigured by LiveTiles There is ne main site setting autmatically set by LiveTiles: The default hme page fr the LiveTiles site will be set t ChsePageType.aspx fr the LiveTiles sub site. 6.4 Lists and Libraries Created by LiveTiles LiveTiles cntains Lists and Libraries in the LiveTiles sub site. It als uses tw existing Libraries within the sub site. These lists and libraries are used t stre files used by the slutin as well as example cntent. It is nt recmmended that yu use these lists and libraries fr yur wn cntent strage as they can be updated r verwritten in future updates Has yur questin been answered? If nt, please visit the relevant Partner (Times Square) r Custmer (42 nd St) Yammer Netwrk and submit yur questin under the Supprt grup. Thank yu. LiveTiles V3 Installatin Guide V1.0 16

Contact Name (This should be the name of the person to contact with application-related issues) Address (see Section V 2.a.vi.

Contact Name (This should be the name of the person to contact with application-related issues) Address (see Section V 2.a.vi. State f Flrida Department f Business and Prfessinal Regulatin Divisin f Alchl Beverages and Tbacc Applicatin fr Brand/Label Registratin Frm # 1 f 5 If yu have any questins r need assistance in cmpleting