Introduction to Prime 4. Prerequisites 5. Deploying the Database 7. Updating the Web.Config 10. Turn-Off SharePoint Mobile 13

Transcription

1 Prime Installation Copyright Atera Prime, Inc. All rights reserved. All trademarks and registered trademarks are property of their respective owners.

2 Prime Installation 1 Introduction Introduction to Prime 4 Prerequisites 5 2 SQL Database Setup Deploying the Database 7 Updating the Web.Config 10 3 Setting Up Mobile 3.1 Turn-Off SharePoint Mobile 13 4 Deploying Prime Run Installation Script 16 Known Issues 18 5 Configuring Prime Activate Prime Features 20 Change Master Page 21 6 Updating Prime 6.1 How to update Prime 24

3 Prime Installation - 3 Introduction

4 Introduction to Prime It s what s missing from SharePoint An improved SharePoint experience that drives adoption and drastically improves productivity. All while making SharePoint fully mobile! Prime addresses many of challenges with SharePoint. It is designed for organizations large and small to maximize their returns in SharePoint by surfacing relevant information and drastically reducing the overhead involved in creating and organizing content. In this guide, we will be covering the installation for Prime. For support, you can us at family@ateraprime.com. Prime Installation - 4

5 Prerequisites In order to deploy Prime, you must have the following ready and configured: 1. SharePoint 2010/2013 Environment 2. SQL Server 2008 R2 and up 3. Direct/RDP access to all servers in the SharePoint Farm 4. Admin user with db_owner provileges to SharePoint Content and Config databases In addition, having a publishing features enabled would make the Prime experience much more seamless and integrated. However, this is a recommendation, and not required, as SharePoint Foundation does not have Publishing Infrastructure. Prime Installation - 5

6 Prime Installation - 6 SQL Database Setup

7 Deploying the Database Prime requires the Prime Settings Database to be deployed. This Database is used by all Prime web parts and components to store configuration data. To deploy the database, please follow the steps below. Prereq: Database Installation Script and SQL Management Studio To deploy the database, we will be using the SQL script provided in the installation package and Microsoft SQL Management Studio. Please make sure that the SQL Authentication has been enabled for SQL Server under Server -> Properties -> Security. The SQL script should reside in the SQL folder of the Prime installation package. Prime Installation - 7

8 Step 1: Connect to SQL You should open and connect to the SQL instance you would like the database to deploy to. Step 2: Open Script inside SQL Server Go to File -> Open -> 'File...' in the top menu and open the SQL Script provided with the Prime Installation package. Prime Installation - 8

9 If you would like to change the name of the database, or the user, you can do a simple Find and Replace and change the database name and the username. Default database name is "PrimeSettings_SP" and default database username is "primesettingsuser". Step 3: Execute the Script After having opened the script, you can simply excecute the script. Prime Installation - 9

10 Updating the Web.Config Once the database has been successfully deployed, we would need to update the web.config file for the all the web applications getting Prime on all servers in the farm. Prerequisites You need access to all the servers in the SharePoint farm. Optional, but recommended would be NotePad++, for easy web.config editing. Step 1: Determine Web.Config Location Web.Config for a web application is usually stored at <Local_Drive>:\inetpub\wwwroot\wss\VirtualDirectories\<WebApp_Port>\web.config. If you have trouble finding this, you should contact your System Administrator for help. Step 2: Backup Web.Config File It is always recommended to backup the web.config file. To do so, make a copy of the Web.Config file, and rename it to web_<year>_<month>_<day>_<hour>_<minute>_<seconds>.bak. Prime Installation - 10

11 Step 3: Update the Web.Config Now you should open the Web.Config. Check to see if you already have a <connectionstrings> tag. If there is, then paste the contents of the <connectionstrings> from below in there. If not, somewhere inside the <configuration> tag, add the <connectionstrings> tag from below. Also, make sure to update the SERVERNAME, DBNAME, USERNAME, and PWD. If you have trouble finding this information, contact your SQL Admin for help. <connectionstrings> <remove name="aterasettings" /> <add name="aterasettings" connectionstring="data Source=SERVERNAME;database=DBNAME;User ID=USERNAME;Password=PWD" providername="system.data.sqlclient" /> </connectionstrings> Step 4 (Optional): Additional Web Applications You must repeat steps 1 through 3 for all Web Applications on which Prime will be deployed. More Servers in Farm If you have more servers in your farm, you must repeat steps 1 through 4 on all of them. Prime Installation - 11

12 Prime Installation - 12 Setting Up Mobile

13 Turn-Off SharePoint Mobile In order for Prime's amazing mobile capabilities to kick in, we must turn of SharePoint's mobile functionality. To do so, please follow the steps below. Prerequisites You need access to all the servers in the SharePoint farm. Optional, but recommended would be NotePad++, for easy web.config editing. Step 1: Determine Web.Config Location Web.Config for a web application is usually stored at <Local_Drive>:\inetpub\wwwroot\wss\VirtualDirectories\<WebApp_Port>\web.config. If you have trouble finding this, you should contact your System Administrator for help. Step 2: Backup Web.Config File It is always recommended to backup the web.config file. To do so, make a copy of the Web.Config file, and rename it to web_<year>_<month>_<day>_<hour>_<minute>_<seconds>.bak. Prime Installation - 13

14 Step 3: Update Web.Config Open the web.config file and add this block in the 'configuration/system.web' child elements: <browsercaps> <result type="system.web.mobile.mobilecapabilities, System.Web.Mobile, Version= , Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" /> <filter>ismobiledevice=false</filter> </browsercaps> Step 4 (Optional): Additional Web Applications You must repeat steps 1 through 3 for all Web Applications on which Prime will be deployed. More Servers in Farm If you have more servers in your farm, you must repeat steps 1 through 4 on all of them. Prime Installation - 14

15 Prime Installation - 15 Deploying Prime

16 Run Installation Script To deploy all the WSPs with the Prime package, we've created a powershell script which automatically deploys and installs all the webparts. To do so, please follow the steps below. Prerequisite You will need a user with Admin access and db_owner access to SharePoint content databse and config database to do this installation. Also, during this process, your SharePoint would be down for about minutes, so plan ahead. Step 1: Copy all WSPs and Deploy.ps1 to a folder You should copy all the provided WSPs and the Deploy.ps1 script into a folder. For ease, copy into C:\PrimeInstallation Folder. Step 2: Run SharePoint Management Shell as an Administrator Prime Installation - 16

17 Step 3: Run Commands to Deploy and Install Prime To install the WSPs, you should run the following commands: > cd "<Directory_Where_Prime_WSPs>" >.\deploy.ps1 This process should take about minutes. Installation Problems If you come across some issues, please check the next page for Known Issues. Prime Installation - 17

18 Known Issues Below are some known issues during SharePoint deployment. Script not digitally signed Please do the following to bypass this: 1. Run >Get-ExecutionPolicy inside the Management Shell. Take note of the policy set. Write it down somewhere. 2. Run >Set-ExecutionPolicy Unrestricted. 3. Run the >.\deploy.ps1 to deploy the WSPs. 4. Reset the Execution policy to what you took note of in step 2 using >Set-ExecutionPolicy <WhatYouWroteDown> Other Issues For other issues, you can contact your System Administrator, as they might have a better idea on the configurations on the system. You can also contact us at family@ateraprime.com. Prime Installation - 18

19 Prime Installation - 19 Configuring Prime

20 Activate Prime Features Prime gives you great control over your SharePoint. You can activate and use Prime on a site collection-to-site collection basis. Even better, you can turn off the Prime features you don't use on certain site collections. Prime uses the SharePoint features to the fullest extent to provide the best experience possible. Prerequisites Site Collection Admin access to the Site Collection activating Prime on. To Activate Prime Go to the Site Collection you want to activate Prime on. Go to Site Actions > Site Settings > Site Collection Features. Here you will see all the Prime features, activate whichever ones you will use. You can activate them all if you like. Also, some features might have 'Beta' in them. These Beta features are still in early stages; thus, have bugs. But they will give you the taste of some of the exciting new things coming in Prime. Of course, Beta is not the end of it. We are always working on new things, and of course, maintaining current release. Prime Installation - 20

21 Change Master Page After activating Prime, you can use the Prime Masterpage, as the Prime Masterpage gives your users a refreshing look and enables the responsive behaviour, which makes SharePoint work on mobile devices and tablets. Step 1: Site Settings Go to Site Settings and click Master Page under Look and Feel. Step 2: Select a Masterpage The following masterpages get shipped with Prime: 1. ap-prime-2010.master: Use this masterpage in most instances. Except, SharePoint Foundation. For Foundation, use ap-prime-foundation.master. 2. ap-prime-edge.master: This masterpage runs modern IE, where as SharePoint reverts all IE versions back to IE8-compatibility. This is an experimental masterpage, and not recommended Prime Installation - 21

22 as some SharePoint functionality might not work. 3. ap-prime-mysite.master: Use this masterpage on a My Sites site. 4. ap-prime-foundation.master: Use this masterpage on SharePoint Foundation environments. 5. ap-prime-configuration.master: Don't use this masterpage. It is for internal Prime use. Prime Installation - 22

23 Prime Installation - 23 Updating Prime

24 How to update Prime So, you want to install a new version of Prime? You will need to the following: 1. Run the powershell script to install the new packages. Refer to this document for instructions. 2. If there is a new Database script, run the script, as it will take care of everything. Make sure to update the database name in the script. More on database setup here. 3. Re-activate all the Prime features in all the site collections using Prime. More info on this here. Prime Installation - 24