Setup Guide (Manual)

Setup Requirements

Software Requirements

  1. Relational Server
    • Microsoft SQL Server 2008 R2 or later (2012, 2014, 2016)
    • Edition: Enterprise, BI, *Standard
  2. OLAP Server
    • Microsoft SQL Server Analysis Services 2008 R2 or later (2012, 2014, 2016)
    • Edition: Enterprise, BI, *Standard
  3. Web Server
    • Microsoft IIS 7.0 (Web Server)
    • .NET Framework 4.5
    • SQL Components
  4. Browser
    • Internet Explorer 10+
    • Microsoft Silverlight 5.0

SQL Components:

Kepion requires the installation of SQL components on the Web Server.  Please install the option according to your version of SQL:

Option 1: When using SQL 2008 or SQL 2008 R2:

    1. Install Microsoft® SQL Server® 2008 R2 Analysis Management Objects
    2. Install Microsoft® SQL Server® 2008 R2 ADOMD.NET
    3. Install Microsoft® SQL Server® 2008 R2 Native Client
    4. Reboot after installation to allow components to register

Option 2: When using SQL 2012/2014/2016:

    1. Install Microsoft® SQL Server® 2012 Analysis Management Objects
    2. Install Microsoft® SQL Server® 2012 ADOMD.NET
    3. Install Microsoft® SQL Server® 2012 Native Client
    4. Reboot after installation to allow components to register

* Learn more about the Kepion SQL Standard Support.

 

Security Requirements

Below are the security requirements for Kepion setup:

  1. Person performing installation must have administrator privilege on Web Server machine
  2. Person performing installation must have administrator privilege on SQL Server/SSAS Server machine(s)

For a quick development setup, you can set the following:

  1. Grant Kepion Service Identity with SysAdmin on SQL Server
  2. Grant Kepion Service Identity with Administrator on SSAS Server
  3. Grant SSAS Service Identity with SysAdmin on SQL Server

Should any of the above settings not work for your environment, please see the advanced security requirements under Advanced Security.

 

Web Server (IIS) Requirements

The following highlighted server roles will be enabled after Kepion installation. You do not need to configure anything at this point.

 

Memory Requirements

It is important to review the memory configuration on both SQL and SSAS servers to ensure an adequate amount of memory is configured for the environment.  By default, SQL and SSAS servers will consume all available memory on a server.  The table below provides recommendation for memory allocation on a typical environment.  If each server is on its own machine, ensure that the host OS also has at least 2 GB of memory.

Production Environment

 Number of Users Web Server SQL Server SSAS Server
Small < 10 2+ GB 4+ GB 4+ GB
Medium < 50 4+ GB 6+ GB 6+ GB
Large > 50 6+ GB 8+ GB 8+ GB

Development Environment

 Number of Users Web Server SQL Server SSAS Server
Small < 10 2+ GB 3+ GB 3+ GB

See the Configure Memory for details on configuring the memory setting for SQL and SSAS.

 


Manual Install Kepion

Verify Prerequisites

Verify that the Setup Requirements are all met and download the following files from the Kepion Resource Center:

Software Downloads > v6.0 > Manual Configuration

  • CPMAppHost.zip
  • EnableFeaturesOnServer.zip
  • Package.zip

 

 

Enable Web Server Features

Unzip the file EnableFeaturesOnServer.zip downloaded from the previous step, and run in a CMD prompt with Administrator privileges. The EnableFeaturesOnServer.bat script will turn on features on the Windows server that Kepion requires for its Web Server.

After running the script, please make sure all the required server roles are enabled.

 

Restore Database – CPMAppHost and Sample POC

On SQL Server, restore both CPMAppHost and Sample POC. From the example below, the Sample POC used is called “Solution-Expense Planning.” The Sample POC can be one from your own environment or it can be downloaded from our list of sample applications.

 

Configure Security

Configure security by reviewing the Advanced Security section.

 

Configure Registry Items

This section lists the registry items required by Kepion installation.

Overview:

You can use Regedit to create the following registry items:

Type Name Description
Key Kepion Create the item under Computer -> HKEY_LOCAL_MACHINE -> SOFTWARE
Key Kepion Planning Create the item under Computer -> HKEY_LOCAL_MACHINE -> SOFTWARE -> Kepion
Key 6.0 Create the item under Computer -> HKEY_LOCAL_MACHINE -> SOFTWARE -> Kepion -> Kepion Planning
String Value ConnectionString Create the item under Computer -> HKEY_LOCAL_MACHINE -> SOFTWARE -> Kepion -> Kepion Planning -> 6.0, with the following value:

Data Source=LOCALHOST;Initial Catalog=CPMAppHost;Integrated Security=True

String Value InstallPath Create the item under Computer -> HKEY_LOCAL_MACHINE -> SOFTWARE -> Kepion -> Kepion Planning -> 6.0, with the following value:

C:\Program Files\Kepion Planning 6.0\

Steps:

  1. Launch Regedit
    Use the run command to launch Regedit.
  2. Create registry folder
    Expand HKEY_LOCAL_MACHINE -> SOFTWARE and create a new Key named Kepion. Create another Key under Kepion and name it Kepion Planning. Under Kepion Planning, create another Key called 6.0.
  3. Create registry entry
    Right click and create a new String Value. Name the value ConnectionString and give it the following value Data Source=LOCALHOST;Initial Catalog=CPMAppHost;Integrated Security=True.

    Create another String Value and give it the name InstallPath. Give the following value C:\Program Files\Kepion Planning 6.0\.

 

Set Up the Directory

Create the following directory on the machine:

  1. Create Directory
    C:\Program Files\Kepion Planning 6.0\
  2. Copy Files to Directory
    Copy the files from the downloaded Package.zip into the Kepion Planning 6.0 directory.

 

Create the Application Pool

Create the Application Pool from Internet Information Services (IIS) Manager. You can launch this from the run command using inetmgr. Right click Application Pools and select Add Application Pool…

Choose the following settings in the Add Application Pool dialog:

Verify the following are configured for the Application Pool:

 

Create a Website in IIS

Create the Kepion Planning Website in the Internet Information Services (IIS) Manager

  1. Create a new Web Site
    Right click on Sites and select Add Web Site….

    Configure based on the following settings. Be sure to click Select… and select the Application Pool created in the previous step.
  2. Enable Windows Authentication
    Double click on Authentication.

    Right click on Windows Authentication and select Enable.
  3. Remove Negotiate Provider for Windows Authentication
    With the Windows Authentication selected, click on Providers….

    Select Negotiate and click Remove.
  4. Grant permission for KepionSI to access Web Site
    Click Edit Permissions…

    On the Security tab, click Edit…

    Add KepionSI, and make sure KepionSI has Read & execute, List folder contents and Read.

 

Launch Website

Launch the website http://localhost:8888 from IE.

 


Configure IE Browser

Please configure this setting for any client that connects to the Kepion server.

Click the Tools button on Internet Explorer, and click Internet options.

Go to Security tab. Select Local intranet.  Click Custom level…

Scroll down to the Scripting section -> Allow Programmatic clipboard access.  Change the selection to Enable and click OK.

 


Advanced Security

The person performing an installation of Kepion should first check if he/she has the necessary privileges to configure Kepion across the various servers within the environment.

Privileges Required for Person Performing Kepion Installation:

Machine Permission Description
Web Server Machine Administrator Need to be an admin on Web Server to install to IIS
SQL Server SysAdmin Need to be an admin on SQL Server in order to add the Kepion SI login
SSAS Server SSAS Administrator Need to be an admin on SSAS in order to add Kepion SI as an admin

 

Kepion SI (Service Identity)

Configure the running context for the Kepion server by specifying the service identity.  For example, it can be a credential such as CORP\KepionSI.  In the Configure SQL Server Security and Configure SSAS Server Security steps, we will ensure that SQL/SSAS have granted access to the Kepion SI.

Privileges Required for Kepion SI:

Machine Permission Description
Web Server N/A No special permission required.  This credential will be configured on the Application Pool “Kepion Planning” when running the Kepion Configuration Wizard.
SQL Server Server Role: dbcreator

Database Role for all Kepion DBs: db_owner

GRANT VIEW SERVER STATE TO [<KepionSI>];

Kepion SI need to have a login on SQL Server with the permissions identified. This allows for Kepion Web Server to function correctly.

Note: If a Kepion database is manually generated via script, be sure to set the default schema for Kepion SI as dbo:
ALTER USER [<KepionSI>] WITH DEFAULT_SCHEMA = dbo;

SSAS SSAS Admin Kepion SI need to have the server admin privilege on SSAS in order to generate new OLAP databases.

Note: For environments where Kepion SI cannot be granted server admin privilege, a server admin will need to manually script out the SSAS database creation. In additional, set the IncrementalOLAPDeploy in [dbo].[ApplicationSettings] to 1. See Step 6 under Configure SQL Server Security for details. This will allow the Kepion Modeler to reuse the existing OLAP database and apply changes on top, rather than regenerating it each time.

 

SSAS SI (Service Identity)

The SSAS SI determines the running context for the SSAS Server.  You can identify the SSAS SI credential by looking at the Log On As in Services.  Write down the identity for use in Configure SQL.


Privileges Required for SSAS SI:

Machine Permission Description
SQL Server GRANT ALTER TRACE TO [<SSAS_SI>];
GRANT CONNECT SQL TO [<SSAS_SI>];
GRANT VIEW ANY DATABASE TO [<SSAS_SI>];
The SSAS SI needs to have these permissions on SQL Server in order for Pro-Active caching to work correctly and to process data during Kepion Deploy.

 

Configure SQL Server Security

Step 1 – Create login for Kepion SI

Open SQL Server Management Studio and connect to the SQL Server instance.  Expand Security and right click on Logins:

Select New Login.  Enter Login name with the Kepion SI credential.

Step 2 – Grant Kepion SI “Server Role” of DB creator

Select Server Roles from the top left pane and check the dbcreator Server Role.  This will allow the Kepion SI to create a new database from the Planning Application.  You can skip this step if you do not want Kepion SI to create new Planning Applications.

Step 3 – Configure “User Mapping”

Select User Mapping from the top left pane.  Map the login to CPMAppHost and to any Kepion application databases (i.e. Sample POC, etc).  Grant db_owner to Kepion related databases.

Step 4 – Repeat Step 1 for SSAS SI

Repeat Step 1 and create a login for SSAS SI.

Step 5 – Grant permissions for Kepion SI and SSAS SI

From SQL Server Management Studio, open a new query window.  Run the following SQL statements to grant the following permissions.  Please be sure to replace the <credentials> with the respective service identities:

 

Step 6 (Optional) – Incremental Deployment Setting

When you cannot have Kepion SI as an admin on SSAS server, please configure the following on each of your Kepion application SQL databases.  Set the IncrementalOLAPDeploy to 1 in the table ApplicationSettings.  This instructs the Kepion Server to never drop the existing OLAP database when deploying changes to OLAP.  Once this is set, please ensure Kepion SI has admin rights to each of the OLAP databases associated with a Kepion application.

Configure SSAS Server Security

Add KepionSI to Server Administrator
Connect to SSAS from SQL Server Management Studio.  Right click on the SSAS Server and select Properties.

Click the Add button to include Kepion SI as a SSAS administrator.

 


Configure Memory

Configure SQL Memory

Connect to your SQL Server using SQL Server Management Studio, right click on the server in the Object Explorer pane, and select Properties.

Select the Memory page and set the Maximum server memory field.  For example, if you want to set 4G of memory, you can enter in 4000.

 

Configure SSAS Memory

Connect to your SSAS Server using SQL Server Management Studio, right click on the server in the Object Explorer pane, and select Properties.

Select the General page and configure the Value column for Memory \ TotalMemoryLimit.  This field is entered as a percentage of the total available memory on the server.  For example, if your server has 20 GB of memory, you can use 20 to represent 20% of 20 GB, which nets to 4 GB of memory.