Setup Guide (Standard)

In this setup guide, we will walk through the steps to install and configure Kepion in your own environment. The video below provides a quick guide to get started. You can find more information about each step from the left navigation.

 

Prepare Kepion Server(s)

Understand Kepion Environment

A typical Kepion environment consists of three key components and two service accounts. It is your choice to configure the three components on a single machine or multiple machines.

Three Components

  1. SQL Server: It is the machine where relational SQL Database Engine is installed.
  2. SSAS Server: It is the machine where SQL Analysis Services is installed.
  3. Web Server: It is the machine where IIS is running.

 

Two Service Identities (SI)

  1. Kepion SI: Kepion SI determines the running context for the Web Server.  It is recommended to create a dedicated domain account as Kepion SI.
  2. SSAS SI: SSAS SI determines the running context for the SSAS Server.

 

Permission Required to Install

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

 

Software Requirements

  1. Relational SQL Server
    • Microsoft SQL Server 2008 R2 or later (2012, 2014, 2016, 2017)
    • Edition: Enterprise, BI, *Standard
  2. OLAP SSAS Server
    • Microsoft SQL Server Analysis Services 2008 R2 or later (2012, 2014, 2016, 2017)
    • Edition: Enterprise, BI, *Standard
  3. Web Server

* Learn more about Kepion SQL Standard Support.

 

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 memory settings for SQL and SSAS.

 


Configure Kepion Server(s)

Verify Prerequisites

Verify that the Software Requirements are all met.

 

Download and Run Installer

Download the following file from the Kepion Resource Center > Software Downloads > v6.0:

  • 6.0 Kepion Setup x64.zip

 

Unzip the file 6.0 Kepion Setup x64.zip, and run the setup file Kepion Planning 6.0.msi.

Step 1 – Welcome Screen

On a Web Server machine, run the Setup MSI.  Click Next.

Step 2 – EULA

On the EULA screen, accept the terms of the license agreement and click Next.

Step 3 – Specify Location

Specify the localization on the machine to install Kepion 6.0.  Click Next.

Step 3a – Upgrade Application

If you are upgrading Kepion from a previous install (only version 5.0 and above) then click Update.

Step 4 – Install

Click Install.

Step 5 – Finish

Click Finish to launch the Configuration Wizard.

 

Configure Kepion Planning

Step 1 – Open Kepion Configuration Wizard from Windows Start

Step 2 – Welcome Screen

Click Next.

Step 3 – Application Host Database

For brand new installation, select “Create a new application host”.
Otherwise select “Connect to an existing one” if this is not the first web server being configured for deployment.  Click Next.

Step 4 – Specify Application Host Settings

Specify the SQL Server machine and database name. You can use the default name of CPMAppHost.  You can also select the default server language.  Click Next.

Step 5 – Specify Service Account

Specify the Kepion Service Account.  This will be the account that will be run the Web Server and connection to both SQL Server and SSAS.  Click Next.

Step 6 – Finish

Click Finish to launch the Kepion 6.0 website.

 

Configure Security

Step 1 – Locate your Kepion SI and SSAS SI

Kepion SI

Configure the running context for the Kepion server by specifying the service identity.  This is the account you specified in Configure Kepion Planning.

SSAS SI

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.

 

Step 2 – Add Kepion SI as SSAS 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.

 

Step 3 – Run the following SQL scripts to enable required credential

Open SQL Server Management Studio and connect to the SQL instance where CPMAppHost is installed.  Run the following SQL statements to grant the required permissions.  Please be sure to replace <KEPION_SI> and <SSAS_SI> with the respective service identities identified above.

If you prefer to configure security step-by-step from the UI, please follow instructions here.

 

Migrate Applications (Optional)

When you migrate Kepion application databases from one environment to another, please make sure Kepion SI and SSAS SI in the new environment have the right permission. Replace <KEPION APPLICATION DB>, <KEPION_SI> and <SSAS_SI> with the respective context.

 


Configure Kepion Client

Each user who connects to Kepion for planning or reporting needs to fulfill the software requirements and configure IE.

Software Requirements

  1. Internet Explorer 10+
  2. Microsoft Silverlight 5.0

 

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.

 


Configure Memory

Recommended Server Memory Allocation

Please find more details from Server Memory Allocation.

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.

 


Uninstall Kepion 6.0

You can uninstall the Kepion 6.0 system from Control Panel ->Programs and Features.  Find Kepion Planning 6.0 and uninstall.

Note that databases will never be dropped during an uninstall process.  If you wish to cleanup databases after uninstall, you must do so manually.

 


Addendum

Description about Kepion SI

Configure the running context for the Kepion server by specifying the service identity.  For example, it can be a credential such as CORP\KepionSI.

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 4 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.

 

Description about SSAS SI

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 Security Step-by-step

Step 1 – Create and configure 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.

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.

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 2 – Create and configure login for SSAS SI

Open SQL Server Management Studio and connect to the SQL Server instance.  Create a login for SSAS SI.  Or you can configure the default “NT SERVICE\MSOLAP…” login.

Grant SSAS SI “Server Role” of public

Select Server Roles from the top left pane and check the public Server Role.

Configure “User Mapping”

Select User Mapping from the top left pane.  Map the SSAS SI login to any Kepion application databases (i.e. Sample App-Advanced, etc).  Grant db_datareader to Kepion related databases.

Every time you add or attach an application to Kepion, you need to grant the SSAS SI login the db_datareader database role to the corresponding Kepion application database.

Step 3 – 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 4 (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.