Download Prime Installation

Prime Installation
Copyright © 2011–2013 Atera Prime, Inc. All rights reserved.
All trademarks and registered trademarks are property of their respective owners.
Prime Installation
1
2
3
Introduction
1.1
Introduction to Prime
4
1.2
Prerequisites
5
SQL Database Setup
2.1
Deploying the Database
7
2.2
Updating the Web.Config
10
Setting Up Mobile
3.1
4
5
6
Turn-Off SharePoint Mobile
13
Deploying Prime
4.1
Run Installation Script
16
4.2
Known Issues
18
Configuring Prime
5.1
Activate Prime Features
20
5.2
Change Master Page
21
Updating Prime
6.1
How to update Prime
24
Introduction
Prime Installation - 3
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 email us at
[email protected].
Prime Installation - 4
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
SQL Database Setup
Prime Installation - 6
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
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
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
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
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
Setting Up Mobile
Prime Installation - 12
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
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=2.0.0.0,
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
Deploying Prime
Prime Installation - 15
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 15 - 30 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
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 15 - 30 minutes.
Installation Problems
If you come across some issues, please check the next page for Known Issues.
Prime Installation - 17
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 [email protected].
Prime Installation - 18
Configuring Prime
Prime Installation - 19
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 Prim e 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
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
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
Updating Prime
Prime Installation - 23
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