08.18.16.CKG
EPM Live 2013 - Installation Guide... 3 Installation Guide Disclaimer... 3 Introduction to EPM Live 2013 - Installation Guide... 4 Pre-Installation... 4 Pre-Installation Setup... 4 Required Information Prior to Installation... 7 Client Desktop Setup (Optional)... 10 EPM Live Installation... 10 EPM Live Installation Package... 10 Deploy Solution Files & Create EPM Live Database... 14 Web.config Modifications... 17 Verify Services... 19 Run Powershell Script on All Servers... 20 SharePoint Central Administration Configuration... 20 Configuration in SharePoint Central Admin... 20 How Do I Manage EPM Live in SharePoint Central Administration? (On-Premise Customers)... 22 Set Up Upland Analytics... 32 Update Upland Analytics Key... 35 Create an EPM Live Site Collection... 37 Create New Site Collection... 37 Setup PPM Backend Site... 40 How do I run the Setup Wizard?... 42 Getting Started Resources... 47 Getting Started Resources... 47 Upgrades... 48 Pre-Upgrade Requirements & Recommendations... 48 Upgrade Steps... 49 Disaster Recovery... 53 Disaster Recovery Considerations... 53 2
EPM Live 2013 - Installation Guide Installation Guide Disclaimer The EPM Live application has a number of important components, installation steps, and security considerations. Please do not attempt to install EPM Live on your own. It is highly recommended that you work with an EPM Live Installation Specialist and/or your EPM Live Account Manager. 3
Introduction to EPM Live 2013 - Installation Guide This Installation Guide includes the Pre-Installation Setup and Installation Steps for installing and activating EPM Live. This guide is specific to the latest EPM Live version 5.x, which is for SharePoint 2013. Installer s Knowledge Pre-requisites The person installing EPM Live must have the following knowledge/skillset: SharePoint 2013 Administration SQL Server Administration SQL Server Reporting Services (SSRS) Administration Internet Information Systems (IIS) Administration Pre-Installation Pre-Installation Setup SQL Server 2012 SQL Server 2012 must be installed and configured for use by SharePoint. During the SharePoint installation, do NOT install using SQL Server Express. If SQL Server Express is used for SharePoint, the EPM Live installation will not be able to take place and SharePoint will need to be re-installed. SP1 is required for SQL Server 2012. SQL Server 2012 Reporting Services is required for use with EPM Live. Mixed Mode Authentication for SQL This is required, because EPM Live uses a SQL Authenticated Account. This is required in order to complete installation of EPM Live. The authentication is either Windows or SQL/Windows (Mixed). If your environment is Windows, change it to Mixed. A SQL authenticated user is required for a connection string that will be stored in the registry. This user will be created during installation or ahead of time if needed. Microsoft Office SharePoint 2013 SharePoint 2013 (Server and Foundation editions are both supported) must be installed and configured before installing EPM Live. On-Premise installations of EPM Live are only performed and supported on dedicated SharePoint Farms (SharePoint Foundation as a minimum requirement). A Dedicated SharePoint Farm is defined as a SharePoint installation in which EPM Live will be the primary solution installed on the farm without additional SharePoint applications installed on the farm. Note that EPM Live recommends running the 2013/5.x software on a farm architecture with a minimum of one WFE/App server and one database server, as shown below: 4
Service Packs EPM Live recommends that Service Pack 1 be installed. March and April CUs are the minimum requirement. Note: This patch level is required for Cloud configuration installs. Current EPM Live Cloud version: 15.0.4505.1002 April 2013 CU SharePoint Foundation 2013 Note: If the client domain contains commas, there is an issue that has been fully resolved with the November 2014 CU. EPM Live on its own SharePoint Farm EPM Live requires its own SharePoint farm. There are two main reasons for this. 1. Performance: If your organization is sharing the farm with other sites and applications, it s impossible for the EPM Live team to give accurate performance recommendation, since we don t know what is happening on the other sites. 2. Risk of interference: If your organization has other sites and applications, it s very possible that our software can interfere with your other sites, and vice versa. We can t know what kind of customizations are going to be done in the other site, and how those customizations will interact with our software. Also, some of our solutions are deployed globally which means that our software may interact with your other site collections. It would be possible for someone with the right permissions to try to activate an EPM Live feature that may cause damage to the other site. Because of this, we see using a shared farm as a risk to both our sites and your other sites. Web Application Setup EPM Live requires that the SharePoint farm should have a Web Application created specifically for EPM Live. On-Premise installation of EPM Live are only performed and supported on dedicated SharePoint Farms (SharePoint Foundation as a minimum requirement). A Dedicated SharePoint Farm is defined as a SharePoint installation in which EPM Live will be the primary solution installed on the farm without additional SharePoint applications installed on the farm. EPM Live supports both Forms and NTLM (Windows) authentication. SharePoint 2013 is all claims based authentication, whether Forms or NTLM. Load Balancer If using Project Publisher, must set the "persistence" setting in your Load Balancer to "Source IP." SQL Server Reporting Services (SSRS) SSRS is a component of SQL and is installed using the same installation files that were used for SQL itself. 5
SQL Server Reporting Services (SSRS) 2012 with SP 1 must be installed on a SharePoint server, configured in SharePoint Integrated Mode. Install both components from the SQL Installation Media on a server connected to the SharePoint Farm. Note: This is required before a new site collection can be created from the Out of Box EPM Live site templates. SQL Server 2012 R2 Reporting Services Add-in for Microsoft SharePoint This add-in must be installed and configured for SSRS to operate properly with the SharePoint Farm. The add-in must be installed on all SharePoint servers in the farm. This can be installed as part of the SQL installation, or downloaded here: http://www.microsoft.com/en-us/download/details.aspx?id=35583 Microsoft Report Viewer 2012 The Microsoft Report Viewer 2012 Redistributable Package can be downloaded at the following URL: http://www.microsoft.com/en-us/download/details.aspx?id=35747 Internet Connectivity Confirm Internet connectivity from the SharePoint Farm server running Central Admin. Internet access without a proxy will be needed to properly authenticate the EPM Live key. If Internet access is not available, please provide the farm GUID. Internet is required for installation of applications. There are no other alternatives at this time. If a proxy server that does not require authentication is used, please refer to the following article to create a configuration file for the WorkEngine timer service so that the service can access the internet to download application content. Article: https://epmlivesupport.desk.com/customer/portal/articles/841857 6
Required Information Prior to Installation SharePoint Application Pool Account (if different than Farm Account) Account must be domain account and not built in service account. This account will also be used to run Timer and Queue services that will be installed into Windows Services. Account must be granted rights to Log On as Batch Job and Log on as a Service. This account must be a Local Administrator on all servers. The Web Application on which you want to install This is the default web application to which you are installing EPM Live. If there are existing non- EPM Live sites, EPM Live requires creating a brand new farm. SharePoint URL This is the URL of the site that will be created using EPM Live. EPM Live does not recommend hosting this site at the root of a web application. For example, http://epm.epmlive.com/sites/epmlive Upland Analytics URL There will be a separate IIS site created for Upland Analytics that must be accessible by the End users. A DNS entry will be needed for this url. The IIS site will be created during installation. For example: http://epmreports.epmlive.com API URL There will be a separate IIS site created for EPMLive API. This site only needs to be accessible to the end users if a third party integration is being used. The IIS site will be created during installation. For example: http://epmapi.epmlive.com 7
SSL Certificates If SSL is needed for the above URLs, please ensure to have the certificate imported into IIS and added to the IIS site accordingly in the binding settings within IIS manager. This must be done on all WFE servers as well as the APP server that is running the WorkEngine Timer service. The entire SSL certificate chain must also be added into SharePoint central admin under the Manage Trusts page. This means that if you have a root certificate, intermediate certificate, etc. that they must all be uploaded into the Manage Trusts page separately as per the example below. Note: This also includes environments that are using SSL offload. Database Server and authentication information Multiple databases are created in SQL for EPM Live. EPM Live relies upon a SQL Authenticated account for internal database requests. Mixed mode authentication must be enabled. Reporting Services URLs This is the full URL to the report server instance. For example, http://server1.company.com/_vti_bin/reportserver. Prior to the installation, validate that SSRS has been successfully installed by browsing to it from a local client machine and from each WFE server. Farm GUID This step is only necessary if you do not have Internet Access available on the application box that runs SharePoint Central Administration. This must be provided for each SharePoint farm that will have EPM Live installed. 8
Note: The farm GUID can be found by either of the following: Using Powershell. Powershell: $farm = Get-SPFarm $farm.id Once EPM Live is installed, the Feature Keys page (located in Central Admin) lists the Farm GUID. Hardware ID There is an optional feature called Designer Forms. If planning to use Designer Forms in any EPM Live Lists, you will need to activate the feature with an activation key. EPM Live will provide a unique activation key based your server Hardware ID. To get your Hardware ID, run the following executable file on EACH Web Front End Server: http://app.ecwid.com/download/1244062/aaf44c4bc212a5bc352ce6ba79e827cc/hidgenerator.exe Contact your EPM Live Installation Specialist and provide them with your Hardware ID(s). They will then provide you with the necessary Activation Keys. Please note, it will take approximately 2 business days for the activation key(s). After the Designer Forms feature has been activated, the Site Feature must be activated. Then, Designer Forms can be created from scratch in any EPM Live List. Also, some pre-created Designer Forms may be available in the App Marketplace. License Keys Locate the email with license keys for the environment. 9
Client Desktop Setup (Optional) The following software and add-ins are to be installed on the client/user machines. These are optional, based on whether your organization will be using these particular features within EPM Live. SharePoint Designer 2013 If web page customization is needed install SharePoint Designer 2013 accordingly. Depending on the amount of customizations to the web pages, SharePoint Designer 2013 may need to be installed in order to make customizations to the web pages. Active-X Controls Most Active X controls have been removed; however, one admin page and one end user feature will require the installation of Active X components. If your organization will be using the Portfolio Cost Views feature, each admin and end user who will configure or use that feature needs to download the v5.5 Active X control. Silverlight 4.0 Required for some of the EPM Live charts. Alternatively, there is an html chart web part that may be created instead of any of the Silverlight chart web parts. Any administrator who will be configuring the use of EPM Live Designer Forms (SP Forms Designer) must have Silverlight installed. Microsoft Project & EPM Live Project Publisher Microsoft Project (2010 or 2013) / Project Publisher (2010) Only required for end users that will be publishing Microsoft Project plans to SharePoint. Project Publisher requires internet access to activate. The version of Project Publisher normally matches the version of Microsoft Project. Project Publisher 2010 works with both Microsoft Project 2010 and 2013. If you are using Project 2007, you will be required to use a custom macro to publish to SharePoint. Trusted Sites EPM Live recommends that the new Web Application URL be entered in the Trusted Sites for all end users to avoid any issues. \ EPM Live Installation EPM Live Installation Package Download Installation Files Installation files can be downloaded at http://downloads.epmlive.com. You will need the order number and email address associated with your order. 10
Run the EPM Live Installation Package The following steps need to be run on the server running the SharePoint Central Admin website. 1. Right-click the installation package, and choose Run As Administrator 2. Click Next on the opening page of the installer 3. Read the EULA details, and select the I Accept radio button. Click Next. Installation Package Custom Setup Window The Custom Setup page will allow you to change the installation path if needed. If you would prefer to change the path or drive that EPM Live installs to, click the Change button. Otherwise, click the Next button. Version Note: As of v5.6.11, EPM Live Installs into the folder "EPM Live 2013." Note: You will need to do this for EACH feature that is being installed. 11
Installation Package - Username & Password 1. Enter in the Username and Password of the Application Pool account. This account will be used to install the EPM Live Timer and Queue service. These are Windows Services, so the account will need to be a local administrator on the Application Server. Note: The username must be in the format of domain\username. 2. Click Install. The wizard will process the installation for a few moments. 3. The wizard will finish installing the services. If there are any errors, troubleshoot them as needed. Click Finish when it is done. Installation Steps for SharePoint Farm with Multiple Web Front End Servers Alternative Farm configuration with multiple Web Front Ends (WFE). The following needs to be done on each Web Front End server, including the Application server(s). Each additional WFE run the EPM Live installer. However, ONLY select the WorkEngine Core & WorkEngine Timer, nothing else (NOT the Application Server or its child items). Each WFE configure the Loopback. Refer to the following article, in which method one is the recommended method: http://support.microsoft.com/kb/896861. Each WFE The host file needs to point the URL back to its own loopback IP address. This prevents a double-hop issue. Additional Step for SharePoint Farm with Multiple Central Administration instances Farm configuration with multiple Central Administration instances requires an IISRESET after the installation package is run. Be sure this is done prior to moving on to the next steps. 12
13
Deploy Solution Files & Create EPM Live Database You will manually deploy the EPM Live solution files into SharePoint. Run Powershell Command to Deploy Solution Files Open SharePoint Powershell. Run the following Powershell command: Note: This will deploy the solutions to the specified web app. Be sure to replace the URL with your URL. Install-SPSolution -Identity workenginecore.wsp -GACDeployment -CompatibilityLevel {14,15} - webapplication https://company.epmlive.com -force Install-SPSolution -Identity workenginewebparts.wsp -GACDeployment -CompatibilityLevel {14,15} - webapplication https://company.epmlive.com -force Install-SPSolution -Identity workenginetimesheets.wsp -GACDeployment -CompatibilityLevel {14,15} -webapplication https://company.epmlive.com -force Install-SPSolution -Identity workenginedashboards.wsp -GACDeployment -CompatibilityLevel {14,15} -webapplication https://company.epmlive.com -force Install-SPSolution -Identity workenginepfe.wsp -GACDeployment -CompatibilityLevel {14,15} - webapplication https://company.epmlive.com -force Install-SPSolution -Identity workengineforms.wsp -GACDeployment -CompatibilityLevel {14,15} - webapplication https://company.epmlive.com -force Install-SPSolution -Identity workenginereporting.wsp -GACDeployment -CompatibilityLevel {14,15} - force Install-SPSolution -Identity workengineworkplanner.wsp -GACDeployment -CompatibilityLevel {14,15} -force Install-SPSolution -Identity workenginesynch.wsp -GACDeployment -CompatibilityLevel {14,15} - force 14
Verify Solutions Installing EPM Live creates a number of new solution files in SharePoint. Make sure these solutions installed properly, and were deployed to the correct Web Application. In Central Administration, click the Manage Farm Solutions link under the Farm Management heading of System Settings. Make sure that all solutions listed in the previous step have a status of Deployed. If they are not globally deployed, ensure that they have been deployed to the web application that EPM Live is being installed on only with the exception of the "workenginecore.wsp" solution file. This solution is deployed to the central administration web application as well. Note: If they are not globally deployed, ensure that they have deployed to the EPM Live Web Application. Create New Database 1. Navigate to SharePoint Central Admin. 2. Open General Application Settings. 3. Open WorkEngine Administration. 4. Open Application Settings. 5. Click the Create Database button to create the EPM Live Database. 15
Create Database Name 1. Enter the Server Name. 2. Enter a Database Name. It is recommended to call it EPM Live. 3. Do not enter a Username or Password. Leave the fields BLANK. Note: If this page errors, you may need to use a SQL authenticated account to create the database. The Username and Password fields on this dialogue box only accept SQL Authenticated credentials, not Windows Authenticated. This account will need to have Sysadmin rights in SQL to create the database. Once the database is created, you can remove the sysadmin rights and change the connection string to use Trusted_Connection as in the example. New Database Connection String 16
Web.config Modifications Make the Following Changes to your Web.config There are some minor changes that need be made in the web.config. NOTE: Prior to changing the web.config file, save a back-up copy of the original. Do this on the Central Admin server and any additional Web Front End servers. 1. Find the web config for the EPM Live Web Application. 2. Edit the web config file in notepad and search for the providers section. Change this value to true. 3. Above the line you just found, add the following line: <add name="multiappcustomsitemapprovider" type="epmlivecore.multiappcustomsitemapprovider, EPM Live Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=9f4da00116c38ec5" /> <add name="epmlivequicklaunchprovider" type="epmlivecore.controls.navigation.epmlivequicklaunchprovider, EPM Live Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=9f4da00116c38ec5" /> 5. Search for the modules section. You will need to apply the following line item to the end of the section, if it s not already there. Be sure to check first. <add name="session" type="system.web.sessionstate.sessionstatemodule" /> 6. Search the web config file for ReportViewerMessages. Comment out this line by adding <!-- before and --> after it, like this: <!--add key="reportviewermessages" value="microsoft.sharepoint.portal.analytics.ui.reportviewermessages, Microsoft.SharePoint.Portal, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" /--> 7. In the </appsettings> section, add the following key: (Note: This is only for windows authentication.) <add key="prefix" value="i:0#.w " /> <add key="domain" value="yourdomainhere" /> (Note: You must do this step if you are Onsite or SSO Authentication.) Replace YourDomainHere with your user domain. (Ex: If your login is corp\username then put corp where it says YourDomainHere.) 17
8. Save the web config file and close it. 9. Reset IIS. Add the following to the web.config on all servers before the closing </configuration> tag <system.web.extensions> <scripting> <webservices> <jsonserialization maxjsonlength="2147483647"/> </webservices> </scripting> </system.web.extensions> Add Execution Timeout to web.config Add executiontimeout= 3600 to the web.config file. Search for httpruntime from the top of the web.config file. Change Enable Session State to true By default, the enablesessionstate is set to "false." Search for enablesessionstate from the top of the web.config file. Change the value from "false" to "true." Ensure to use lowercase letters. 18
Verify Services EPM Live installs two Windows Services, PortfolioEngine Queue and WorkEngine Timer Service. These services will only be installed on the application server where all EPM Live components were installed. Verify PortfolioEngine Queue Service Click on Start, then under Administrative Tools, select the Services applet. Scroll down until you find the PortfolioEngine Queue and make sure its status is set to Started. Start the service if it is stopped. Verify WorkEngine Timer Service Click on Start, then under Administrative Tools, select the Services applet. Scroll down until you find the WorkEngine Timer and make sure its status is set to Started. Start the service if it is stopped. 19
Run Powershell Script on All Servers The following is to prevent an issue where in some cases the license type is unable to be changed/set due to a denied access issue. Run the Script 1. Run the following PowerShell script on ALL servers. 2. Reset IIS. $contentservice = [Microsoft.SharePoint.Administration.SPWebService]::ContentService $contentservice.remoteadministratoraccessdenied= $false $contentservice.update() SharePoint Central Administration Configuration Configuration in SharePoint Central Admin After the installation has completed, finish configuration steps in Central Administration. Activate the Feature Key EPM Live will need to be activated in order to use the new functionality. In Central Administration, General Application Settings, click the Feature Keys link under the WorkEngine Administration heading. You should have received a Primary Feature Key from EPM Live to activate your installation. If you servers do not have internet access, or are behind a proxy, you will need to use a manual key. Simply send the Farm Guid found on this page along with your key to your EPM Live representative, and they will assist you. Enter your key into the Add Key section of the Feature Key page and click the Activate button. You should see the key listed in the top part of this page, along with each feature you have access to and how many users are active for each feature. 20
Update RSQL Server Reporting Services Information Click the Application Settings link under the EPM Live Administration heading of the General Application Settings page. This page displays the connection string used for EPM Live for each Web Application, as well as the SSRS information. Be sure to enter the URL for Reporting Services for your EPM Live web application, along with the Use Integrated Mode box. In the Username and Password fields, you must enter the service account that is running the web application on which EPM Live is installed. Enter the username in the form of domain\username. This is the account that will be used to authenticate to SSRS, so it must have the permissions to read and execute in SSRS. 21
How Do I Manage EPM Live in SharePoint Central Administration? (On- Premise Customers) This article will show you the EPM Live settings available in SharePoint Central Administration. This article applies only to On-Premise customers. 1. Open SharePoint Central Administration From the Server Start Menu, select SharePoint 2013 Central Administration. 22
2. Open General Application Settings Under the Central Administration Heading, select General Application Settings. 3. EPM Live Settings Section Under the EPM Live Administration section, EPM Live has the following links for management of EPM Live. Feature Keys Reporting Configuration Queue Application Settings Active Servers Solution File Versions Create Site Collection Manage Email Templates Properties 23
3.1 EPM Live Settings Section (Prior to v5.6.11) Under the WorkEngine Administration section, EPM Live has the following links for management of EPM Live. Feature Keys Reporting Configuration Queue Application Settings Active Servers Solution File Versions Create Site Collection Manage Email Templates 24
3.2 Feature Keys This page shows the EPM Live keys that have been activated in your SharePoint environment. The keys enable (allow) for the various EPM Live features, settings, and tools to be available on your server(s). This page is also where additional keys are added, such as when additional users are purchased, or new functionality is to be enabled. If needed, the Farm Guid is shown on the page, under the field for activating new keys. When a user is disabled in EPM Live, it is recommended to come to the Feature Keys page to remove that user from whichever features that user was active. This will free up the license access to that/those features for an additional user. 25
Note: For customers whose servers do not have internet access, a "special key" will be created for your organization. To create the special key, you will need to provide your Farm Guid to your EPM Live Account Manager. 3.3 Reporting Configuration This page shows each site collection's mapping to its EPM Live Reporting Database. New mappings can also be set up here. The mapping details include: Site Collection Database Server Reporting Database Name 3.4 Queue This page allows for management of the EPM Live Queue (Timer) settings. 1. Enter the number of seconds for the Queue Interval. This specifies how often the queue attempts to retrieve items awaiting the queue. 2. Enter the Thread Count. This specifies the number of concurrent threads the queuing system will run. 3. Enter the Security Thread Count. This specifies the number of concurrent security threads the queuing system will run. Version Note: The Security Thread Count feature is available as of version 5.6.9. 26
3.5 Current Queue Status This page shows the current Queue Status for the selected Web Application. 3.6 Application Settings - Solution Deployment This page shows which EPM Live solution files have been deployed on the server. 3.7 Application Settings - Database Connection String 27
This page displays the connection string used for EPM Live for each Web Application. The Connection String needs to be entered for the EPM Live web application, as well as Central Administration. If your Central Administration web application doesn t have a connection string, you can copy it from the EPM Live web application. The Status dialog will turn green when you click Save Settings if your connection string is entered properly. 3.8 Application Settings - Reporting Services Configuration This page shows the SSRS information. Be sure to enter the URL for Reporting Services for your EPM Live web application, along with the Use Integrated Mode box. 3.9 Active Servers This page shows the active Web Front End (WFE servers) in the SharePoint Farm. If you have a "server" key rather than "user" key, you would be able to specify the server(s) on which to activate the key. 28
3.10 Solution Files Versions This page shows each of the EPM Live Solution Files and their corresponding version numbers. 29
3.11 Create Site Collection This page is the recommended approach for new EPM Live Site Collections. Using this method ensures that the EPM Live templates, settings, etc. are set up correctly in the new Site Collection. 3.12 Manage Email Templates This page shows the email templates that go out to users. Example emails include when a new user is added to a site, when a new comment has been entered, when a user is assigned to a work item, and when a project manager's project has pending updates in the Online Project Planner. You may edit the body of these emails as needed. 30
3.13 Properties By default, the Upland Analytics and EPM Live API Properties are adding via the Properties page. Version Note: This page is available as of v5.6.11. 31
Set Up Upland Analytics This article explains how to set up Upland Analytics in your EPM Live environment. EPM Live s newest BI tool, Upland Analytics, is available as of v5.5. To properly install and activate the Upland Analytics feature, contact your EPM Live Installation Specialist for assistance. 1. Prepare for Upland Analytics Extract the API and UplandAnalytics folders to the folder that EPM Live was installed in. They are located here by default: C:\Program Files (x86)\epm Live\EPM Live 2013. In the API folder, modify the web.config. Change the value for Web Application to match the name of the IIS Site that hosts the EPM Live site collection. In the Upland Analytics folder, modify the web.config file and fill out the connection string to go to the EPM Live database. 1.1 Prepare for Upland Analytics (Prior to v5.6.11) One server must be chosen to run the Upland Analytics sites. This server will need two new DNS entries pointing to it, one for API and one for Reporting. Download the following files before installation of Upland Analytics: http://downloads.epmlive.com/downloads/propertybagsettings2013.zip http://downloads.epmlive.com/downloads/clients/api.zip http://downloads.epmlive.com/downloads/clients/uplandanalytics.zip Extract the API and UplandAnalytics folders to the folder that EPM Live was installed in. In the API folder, modify the web.config. Change the value for Web Application to match the name of the IIS Site that hosts the EPM Live site collection. In the Upland Analytics folder, modify the izenda.config file and fill out the connection string to go to the Reporting database. In the Upland Analytics folder, modify the web.config file and fill out the connection strings to go to the Reporting and EPM Live databases. 2. Create New IIS Sites Create new IIS Sites for each API and UplandAnalytics. Each site should use the same application pool as the site hosting EPMLive. Typically we use a host header for each of these sites; i.e. epmapi.epmlive.com and epmreporting.epmlive.com. 32
3. Update Property Bag Navigate to Properties Page. Update the Upland Analytics URL to point to the site created in IIS. Update the EPM Live API URL to point to the site created in IIS. 3.1 Update Property Bag (Prior to v5.6.11) Extract the propertybagsettings2013 zip file and place the wsp somewhere accessible on the server. Run the following command to add the solution to the sharepoint farm: Add-spsolution literalpath c:\... (point that to the file) In Central Admin, under System Settings, click on Manage Farm Solutions. Deploy the PropertyBagSettings solution globally. Under System Settings, there should now be a link to customize the property bag. Click it. Click the button next to the farm section to modify the property bag for SharePoint_Config Add a new property: Key: UplandAnalyticsURL Value: use the URL you set for the host header of the UplandAnalytics IIS Site. (http://epmreporting.epmlive.com) 33
Select the EPM Live application from the drop down, and click the button to modify the property bag for it. Add a new property: Key: EPMLiveAPIURL Value: use the URL you set for the host header of the API IIS Site. (http://epmapi.epmlive.com) 34
Update Upland Analytics Key Note: These instructions are for on-premise customers only. The Upland Analytics license key expires annually for on-premise customers. This article explains how to replace your expired Upland Analytics key with your new key each year. The actual key will be sent in an email from the Upland EPM Live team. 1. Navigate to Server Navigate to your server that hosts Upland Analytics. 2. Open IIS Manager 1. Select your site that hosts Upland Analytics. 2. Click the Explore link. 35
3. Open web.config This will open up Windows Explorer. Search for web.config and open with Notepad. 36
3.1 Replace License Key Find the old value for IzendaLicenseKey and replace with the new value that was provided. Save file. Close file. 4. Update izenda.config Depending on your version of Upland Analytics, you may or may not have an izenda.config file. If you DO NOT have an izenda.config file, disregard this step. If you DO have an izenda.config file, update the izenda.config file with the new key as well. 5. Reset IIS Create an EPM Live Site Collection Create New Site Collection Create the Site Click the Create Site Collection link under the EPM Live Administration heading of the General Application Settings page in Central Administration. 37
Select Web Application 1. Select the EPM Live Web Application. 2. Give the new site a title and description. 3. Select the new URL. Note: It is highly recommended to create the site collection at a managed path rather than at the root of the web application. However, there must also be a SharePoint site create at the root of the web application (as it is a requirement for SharePoint and SSRS). This root site does not have to be an EPM Live site. It should be created as an out-of-the-box SharePoint site, such as a Team Site. The "everyone" group must have read access to this site in order for SSRS to work correctly. 4. Be sure that the PortfolioEngine or WorkEngine Site App solution is selected in the dropdown. 5. Use the Service Account for the Primary Site Collection Administrator. Create Reporting Database 1. For the Reporting Database section, select the New radio button. 2. Enter the SQL Server name and a database name. EPM Live recommends using the site name and appending _Reporting to make it easy to find. 3. When finished, click the OK button. 38
When your new site collection is created, you will be directed to the new site collection. There are now additional steps to be completed in the site collection. Refer to the next lessons to complete the installation process. 39
Setup PPM Backend Site When directed to the new site collection, there is also a PPM site to be created on the back-end. Open the Setup PPM Site Navigate to the EPM Live Setup page by adding _layouts/ppm/setupppm.aspx to the end of the URL of your site. Setup your Site Leave the Base Path as it is pre-populated. Enter in your Product Key for EPM Live and the Company name exactly as it was received by EPM Live. The database name you enter into the Database Information section will be created in SQL by EPM Live. Enter your Database Server name. Typically the Database Name will be your base path followed by _EPM Live. The User Name and Password will also be created in SQL as a SQL Server Authenticated Account. This account is used for back end communication with the EPM Live database. Click Setup Site. Complete Setup Reload the Setup Status page until you receive the Complete status. 40
Note: If the status stays as "Queued" after several minutes of refreshing the page, make sure the WorkEngine Timer service is started. If the service is started, then try restarting it and the job should run. Registry Modifications There are some additional minor changes that need to be made to the registry after the PPM site setup is complete. Export the Registry Key On the initial server install (Central Admin Server) export the following registry key. 1. Type regedit in a command prompt and navigate to the following key location. HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\EPMLive. 2. Right click on EPMLive as show above and click the export option. 3. Save the file somewhere easy to find and copy the file to all additional web front end servers and application servers. Import the Registry Key To import the key onto additional servers double click the registry file you exported and saved from previous steps. You will be prompted to ask if you are sure you want to do this. Click the yes button. 41
How do I run the Setup Wizard? When a new EPM Live Site App is created, the Setup Wizard runs to guide you through some important settings for use. There are also some administrative actions taking place behinds the scenes for your site creation, so it's very important that the Setup Wizard be run at least once. The Setup Wizard can also be run on-demand at any time. Some important actions that take place when the wizard runs: All reports in the Report Library (Classic Reports) are updated with your Site Collection's Reporting Database as their Data Source. Two new permissions groups are added to the Resource Pool: Report Writers & Report Viewers (for Upland Analytics reports). Version Note: As of v5.6.9, the Timer Service time selection is no longer included in the Setup Wizard. 1. EPM Live Setup Wizard After creating your Site App, you will be prompted to run the EPM Live Setup Wizard. Click the Next button to get started. 42
1.1 Step 1: Reporting Setup The Setup Wizard next creates the data source to be used for the SSRS (SQL Server Reporting Services) reports. This step also maps the Site App to the Reporting Database, which allows your List Apps and features use the Reporting Database as their Data Source. 1. Reporting Details & Credentials For on-premise environments, input the username and password for the account with access to the SQL database. Enter the Username and Password of the account that will be used in the data sources for the SSRS reports. Be sure to select the "Use as Windows Credentials" box if using the web application account in the format of domain\username. Alternatively, a SQL account can be used instead, so that the EPM Live End Users (typically a site collection administrator) can create their own adhoc SSRS reports. This way, the service account and credentials would not have to be given to the end users, nor do the end users need direct access to the reporting database. Instead, the SQL account credentials would be given. A SQL account is better for security reasons and administration overhead. If using a SQL account, do NOT select this checkbox, and ensure that the account specified has at least datareader permissions to the reporting database as well as execute permissions for all the stored procedures that have the "dbo." prefix. For hosted/online environments, this data will auto-populate with the reporting details for the Site App. The boxes are grayed out and un-editable, as the information is already populated for you. 43
Note: This part of the Setup Wizard configures the SSRS reports in the Report Library by updating the data source in each report to be the EPMLiveReportDB specific to your Site App. 2. Click the Next button. Note: If needed, you can also click the Back button to go back to the previous Setup Wizard step. 1.2 Step 2: Services Setup 1. Notifications Service Run Time: Click the drop down menu to select what time the Notifications should run. The Notifications Service will run daily at the specified time to send notification emails to users, based on the settings configured with the Notifications Settings page. If you set the time for the Notifications Service, you must also go configure the Notification Settings page in order for them to work. For more information on the Notifications Service, see the Notifications Service article. 2. Reporting Refresh Run Time: Click the drop-down to determine what time the Reporting Refresh should run. This service will run daily at the time you specify and refresh your reporting data tables, which includes the timesheet table, portfolio cost and resource tables, security table. Also, large content that was deleted won't delete until the Refresh is running to reduce performance issues, such as list deletion or workspace deletion. 3. Click the Next button. 44
1.3 Step 2: Services Setup - Prior to v5.6.9 Version Note: As of version 5.6.9, the Timer Service Run Time has been removed from the Setup Wizard, and the functionality of the Timer Service has been changed. Timer Service Run Time: (Only applicable to versions 5.6.8 and earlier) Click the drop-down to determine what time the Timer Service should run. The Timer Service will run daily at the time you specify. The Timer Service performs various administrative tasks such as recalculating & refreshing fields throughout the system. The Timer Service does utilize a considerable amount of system resources and is recommended to be run off hours. For more information on the Timer Service, see the Timer Service lesson. Note: It is highly recommended that you set a time for the Timer Service to run at a scheduled daily time, which keeps the data refreshed throughout the Site App. 45
2. Wizard Complete 1. Yes/No: The last step of the Wizard asks if you'd like to be directed to some additional configuration steps after the Setup Wizard finishes. If you select No, you can return to the additional configuration steps via the Getting Started option on the Settings Gear drop down 2. Finish: Regardless whether your select Yes or No for the additional configuration steps, be sure to click the Finish button to allow the wizard to finish completely (do NOT just click the X button to close the window). 3. Setting Up Site In Progress 46
4. Return to Setup Wizard or Getting Started Page 1. If you need to re-run your Setup Wizard, select Setup Wizard link from the Settings Gear Navigation Menu. 2. If you ever want to return to Getting Started Page, you can navigate there by selecting the Get Started! link from the Settings Gear Navigation Menu. Getting Started Resources Getting Started Resources Online Resources EPM Live Website: http://epmlive.com Training Documentation & EPM Live Knowledgebase: support.versata.com ActiveX Controls: http://downloads.epmlive.com/portfolioengine/ (These are only necessary for users who will be managing or viewing the Portfolio Cost Views Reports. 47
Upgrades Pre-Upgrade Requirements & Recommendations This article explains what is needed prior to doing an upgrade. 1. Prior Information and Files Required Please have the following information: SharePoint Setup & Service Accounts Web application that is hosting EPM Live Please have the following downloaded and available: EPM Live Installer for the new version to which you are planning to upgrade. 2. Pre-Upgrade Recommendations Take SQL Database backups of the following: PortfolioEngine Database Reporting Database EPM Live Database 48
Upgrade Steps This article explains how to do an EPM Live upgrade. Be sure to verify you have first completed the Pre- Upgrade Requirements and Recommendations prior to upgrading. Version Note: The EPM Live solution files were renamed to EPM Live 2013 as of v5.6.11. Prior to v5.6.11, they were WorkEngine 2013. 1. Restart IIS Restart IIS on all application and web front ends server to remove any users active on the system. 1. Open CMD prompt on application server. 2. Type in iisreset and press enter. 2. Restart the SharePoint Timer Service Restart the SharePoint Timer Service. 1. On the Start Menu, select Services OR go to Run then services.msc. 2. Scroll down to the SharePoint Timer service. 3. Right click and Restart. 3. Restart WorkEngine Timer Service Restart WorkEngine Timer Service on the application server. This will clear out any stuck or finished jobs in the Timer Queue. This will also pause any in-progress jobs. 1. On the Start Menu, select Services OR go to Run then services.msc. 2. Scroll down to the WorkEngine Timer service. 3. Right click and Restart. 4. Restart PortfolioEngine Queue Service Restart PortfolioEngine Queue Service on the application server. 1. On the Start Menu, select Services OR go to Run then services.msc.. 2. Scroll down to the PortfolioEngine Queue service. 3. Right click and Restart. 5. Download and Copy EPM Live Installation File Copy EPM Live installation file to the application server and web front end servers. 1. If customer is On-Premise, they can obtain the new installation file as long as they have paid their annual maintenance fee. 49
2. They will need to download the latest installer via downloads.epmlive.com. 3. Customer needs the account email address and order number to request the installer file. 4. The installation file will be emailed to the account email address on file. 6. Uninstall WorkEngine 2013 from Each Web Front End Server On each web front server, go to Programs and Features, then Uninstall WorkEngine 2013. This removes the EPM Live solution files. 7. Uninstall WorkEngine 2013 from the Application Server On the application server, go to Programs and Features, then Uninstall WorkEngine 2013. This removes the EPM Live solution files. 8. Restart the SharePoint Timer Service Restart the SharePoint Timer Service. 1. On the Start Menu, select Services OR go to Run then services.msc. 2. Scroll down to the SharePoint Timer service. 3. Right click and Restart. 9. Run New Installer on Application Server Run the new installer on the application server (server hosting Central Administrator and EPM Live Services). 1. Right Click. 2. Run as Administrator. 3. Make sure all components are selected. 4. Change Paths to where EPM Live was initially installed 5. Use EPM Service Account or Application Pool account. 6. Click Next. Deploying and Installing the solution files may timeout and fail ( Solution did not deploy in a timely fashion ). Did the installer timeout? If installer did NOT timeout, Go To Step 10. If the installer DID timeout, Go to Step 12. 10. Install Solutions If installer did not timeout, then you can install the Solutions and upgrade the EPM Live Database from the Central Admin Application Settings page. 50
1. Go to Central Administration, General Settings, Application Settings. 2. Make sure that the Central Admin web application is showing. 3. Click Install Solutions. 4. On the same page, click on Upgrade button which will upgrade the EPM Live database. 11. Run New Installer on All Web Front Ends Run new installer on all web front end servers. 1. Right Click. 2. Run As Administrator. 3. Make sure only WorkEngine Core is selected. 4. Click on Application Server; This feature will not be available. 5. Change Paths to where EPM Live was initially installed. 6. Use EPM Service Account or Application Pool account. 7. Click Next. 12. Check if the WorkEngine Core is deployed to Central Administration Check if the WorkEngine Core is deployed to Central Administration. If not, run the following command in PowerShell on the app server to force deploy. 1. In Central Admin go to System Settings. 2. Under Farm Management, click on Solution Management to check if workenginecore.wsp solution deployed to the Central Admin web application. If not, run the following in PowerShell. 1. Replace the URL after webapplication with your respective web application URL for each solution. (no brackets): Install-SPSolution -Identity workenginecore.wsp -webapplication {webapplicationurl} -GACDeployment -CompatibilityLevel {14,15} force. 2. Navigate to the Solution Management page in Central Administration to verify it has finished deploying. 13. Make sure the remaining solutions were deployed to the application server Make sure the remaining solutions were deployed to the application server. If not, you will need to force deploy them; see below. 1. Open PowerShell; 2. Paste and run the commands below to deploy solutions. 51
3. Replace the URL after webapplication with your respective web application URL for each solution. 4. Navigate to the Solution Management page in Central Administration to verify it has finished deploying. 13.1 PowerShell Commands Install-SPSolution -Identity workenginecore.wsp -webapplication https://epm.customerwebapp.com -GACDeployment -CompatibilityLevel {14,15} -force Install-SPSolution -Identity workenginewebparts.wsp -webapplication https://epm.customerwebapp.com -GACDeployment -CompatibilityLevel {14,15} force Install-SPSolution -Identity workenginetimesheets.wsp -webapplication https://epm.customerwebapp.com -GACDeployment -CompatibilityLevel {14,15} force Install-SPSolution -Identity workenginedashboards.wsp -webapplication https://epm.customerwebapp.com -GACDeployment -CompatibilityLevel {14,15} force Install-SPSolution -Identity workenginepfe.wsp -webapplication https://epm.customerwebapp.com - GACDeployment -CompatibilityLevel {14,15} force Install-SPSolution -Identity workengineforms.wsp -webapplication https://epm.customerwebapp.com -GACDeployment -CompatibilityLevel {14,15} -force Install-SPSolution -Identity workengineworkplanner.wsp -GACDeployment -CompatibilityLevel {14,15} force Install-SPSolution -Identity workenginereporting.wsp -GACDeployment -CompatibilityLevel {14,15} - force Install-SPSolution -Identity workenginesynch.wsp -GACDeployment -CompatibilityLevel {14,15} - force 14. Go to General Applications Settings to Upgrade EPM Live database 1. WorkEngine Administrator- Application Settings 2. Click Upgrade button to upgrade the EPM Live database. 15. Go to Services On the application server, go to Services and start the following: WorkEngine Timer PortfolioEngine Queue 16. Go to the EPM Live Site Collection Go to the EPM Live site collection 52
1. Append the following to your site URL: **EPMLiveSiteName**/_layouts/EPMLive/upgrade.aspx 2. Accept Terms 3. Make sure there are no errors or failures in the results. 4. Go to the following URL: **EPMLiveSiteName**/_layouts/EPMLive/upgradereportingdb.aspx 5. Click Upgrade Now. 6. Make sure there are no errors or failures in the results. 17. Run Reporting Cleanup All 1. Navigate to the Reporting Settings page. 2. On the Actions menu, click Cleanup All. 3. Click Cleanup to confirm. 18. Run Functional Tests Run functional tests to ensure correct functionality. 19. Follow Up If you experience any errors, please reach out to your Customer Success/Account Manager. Disaster Recovery Disaster Recovery Considerations EPM Live aligns with the Microsoft processes and best practices for SharePoint. There are three primary ways to do the backup/restore of the SharePoint environment; EPM Live supports all three: Backup/Restore via the UI Backup/Restore via a command line Backup/Restore via the content DB backup In addition to SharePoint s standard process for backup and restore, do the SQL DB backup and restore on the following custom EPM Live databases: EPM Live Content DB (also referred to as the EPM Live Reporting DB) This is only needed if snapshot data has been saved, if snapshots have been taken. EPM Live DB (Timesheets) This is only needed if timesheets are in use. If not using Timesheets (and there is no historical timesheet data), the installer can be rerun to create the DB rather than doing a backup/restore of this DB. PortfolioEngine DB (only if the Enterprise Level Portfolio Resource and Cost Planning tools are in use either configuration and/or saved portfolio data). 53