DashInsight

Installation and
Configuration Guide

3 4
Copyright 2009-2015 DataClarity Corporation. All rights reserved.
This software and related documentation are provided under a subscription or demonstration agreement
containing restrictions on use and disclosure and are protected by intellectual property laws. Except as
expressly permitted in your subscription or demonstration agreement or allowed by law, you may not use,
copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this
software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
EXCEPT AS PROVIDED IN THE SUBSCRIPTION OR DEMONSTRATION AGREEMENT, ALL SOFTWARE
AND SERVICES ARE PROVIDED AS IS. DATACLARITY DISCLAIMS ALL WARRANTIES, WHETHER
EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE AND THERE ARE HEREBY EXCLUDED ALL
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL DATACLARITY BE LIABLE FOR ANY INCIDENTAL, INDIRECT, EXEMPLARY,
SPECIAL OR CONSEQUENTIAL DAMAGES, UNDER ANY CIRCUMSTANCES, INCLUDING, BUT NOT
LIMITED TO, LOST PROFITS, REVENUE OR SAVINGS, LOSS OF GOODWILL, OR THE LOSS OF USE
OF ANY DATA, EVEN IF DATACLARITY HAD BEEN ADVISED OF, KNEW, OR SHOULD HAVE KNOWN,
OF THE POSSIBILITY THEREOF. UNDER NO CIRCUMSTANCES SHALL DATACLARITYS AGGREGATE
CUMULATIVE LIABILITY HEREUNDER, WHETHER IN CONTRACT, TORT, OR OTHERWISE, EXCEED THE
FOLLOWING AMOUNTS: WITH RESPECT TO CLAIMS RELATED TO THE SOFTWARE OR MAINTENANCE
AND SUPPORT SERVICES, THE TOTAL AMOUNT OF ANNUAL SUBSCRIPTION FEES ACTUALLY PAID BY
YOU UNDER THE SUBSCRIPTION OR DEMONSTRATION AGREEMENT; AND WITH RESPECT TO CLAIMS
UNDER A STATEMENT OR WORK, THE AMOUNT RECEIVED BY DATACLARITY UNDER THE STATEMENT
OF WORK.

Table of Contents
> Introduction
> Prepare for Installation and Configuration
> Check the System requirements
> Setup the Environment
> Installing DataClarity DashInsight software
> Importing DashInsight Content
> Configure Microsoft IIS
> Configure and Start DashInsight Services
> Create DashInsight Content Store Objects

3 4

Introduction
This document is intended for use with DataClarity DashInsight. DataClarity DashInsight
is an innovative IBM Cognos accelerator platform that delivers best-in-class user
enhancements, mobile applications, and pre-built analytic content to fast track analytics
development, deployment, and user adoption.
This document provides the information you need to install and configure DataClarity
DashInsight on a Microsoft Windows operating system using a single-server or multiserver installation. The installation is suitable when you are setting up a test or evaluation
environment, or for development and production environments.

Audience
To use this guide, you should be familiar with:
Basic Microsoft Windows operating system administration skills
IBM Cognos administration and configuration skills
Database objects creation and client connection concepts
Microsoft IIS Web server configuration

Finding information
To find DataClarity DashInsight product documentation on the web, access www.IBM
CognosDashboards.com or www.DataClarityCorp.com.
You can also read PDF versions of the product release notes and installation guides
directly from DashInsight installation packages.

Printing Copyright Material

You can print selected pages, a section, or the whole document. You are granted a nonexclusive, non-transferable license to use, copy, and reproduce the copyright materials,
in printed or electronic format, solely for the purpose of installing and configuring
DataClarity DashInsight software.

3 4

Prepare for Installation and Configuration

To install and configure DataClarity DashInsight, you should follow the steps below:
Check the system requirements
Set up the environment
Install and configure the DashInsight software
Configure the IBM Cognos environment
Activate DashInsight license and users

Check the System requirements

Before you install DataClarity DashInsight, ensure that your computer meets the software
and hardware requirements. The hardware requirements depend on your IBM Cognos
environment. You may require additional resources, such as disk space.
Use the following tables to check the minimum hardware and software requirements
to install and run DataClarity DashInsight components on one computer. Additional
resources may be required for distributed or production environments.
To ensure that your product works properly, apply all minimum required operating
system patches and use only the versions of other software that are supported for a
DashInsight product.

Installation Requirements - Hardware

Requirement

Specification

Operating system

Microsoft Windows
UNIX / Linux

Disk space

A minimum of 1.0 GB of free space is required to install

the software, and a minimum of 2.0 GB of free space
required for the temporary files and logs.
Based on number of users, specific capabilities, and the
usage frequency of specific capabilities, the memory
usage may increase over time. Ensure that you monitor
the logs and temporary files and have sufficient disk
space allocated.

3 4
Requirement

Specification

Memory

Use the following memory settings as a starting point

and adjust them based on the memory usage of your
system.
2 GB for the base operating system and accompanying
software, such as antivirus, back up, and enterprise
management software
Minimum 4 GB for each DashInsight tier component
(Gateway, App, or Single Server).
If DashInsight Application tier is installed on the same
server with the Gateway tier, but in separate installations,
then minimum 8GB (4GB + 4GB) are required for both
components to run.
Based on number of users, specific capabilities, and
the usage these frequency of specific capabilities, the
memory usage may increase. Such capabilities include:
Data Discovery Files Parsing and Profiling
Publishing

Content Store

Initial Sizing:
2.0 GB for each 1,000 DashInsight named users.
1GB auto-growth option enabled
Based on number of specific capabilities, and the usage
frequency of these specific capabilities, the Content
Store usage may increase. Such capabilities include:
Data Discovery Personal Files
Presentations
The size may increase over time. Ensure that you monitor
the content store sizing and have sufficient space
allocated.

3 4

Installation Requirements - Software

Requirement

Specification

IBM Cognos

IBM Cognos 8.x, 10.x, or Express must be installed

Database

You must have one of the following databases available to

store DashInsight metadata:
Oracle (version 9g or above)
Microsoft SQL Server (version 2005 or above)

Apache Tomcat

Apache Tomcat (version 7 or above) must be installed.

The Apache Tomcat is included in DashInsight installation
package

JRE 7

Java Runtime Environment (version 7 or above) must be

installed. The JRE7 is included in DashInsight installation
package.

Web browser

You must have Internet Explorer, Chrome or Mozilla Firefox

browser installed.
The following must be enabled:
Cookies
JavaScript
Run ActiveX controls and plug-ins
Script ActiveX controls marked safe for scripting
Active scripting
Allow META REFRESH

3 4

Setup the environment

Before you install DataClarity DashInsight, ensure that your computer meets the software
and hardware requirements. The hardware requirements depend on your IBM Cognos
environment. You may require additional

Create the DashInsight content store

The DashInsight content store is a database that DashInsight uses to store global
configuration data, global settings and product-specific content. You must use one
of the supported enterprise-level databases as the content store in a production
environment.
You must create the content store before you install and use DashInsight product.
For creating the content store database you should use one of the databases listed in
the following table:

Character Encoding and Protocol Used by Databases

Database

Character Encoding

Protocol

Oracle

AL32UTF8 or AL32UTF16

TCP/IP

Microsoft SQL Server

UTF-8 or UTF-16

TCP/IP

Collation Sequence
DashInsight uses a single sort order that specifies the rules used by the database
to interpret, collect, compare, and present character data. For example, a sort order
defines whether the letter A is less than, equal to, or greater than the letter B; whether
the collation is case sensitive; and whether the collation is accent sensitive.

Suggested Settings for Creating the Content Store in Oracle

The database you create for the content store must contain the specified configuration
settings.
To ensure a successful installation, use the following guidelines when creating the
content store. Use the same guidelines to create a database for log messages.

3 4
Use the following checklist to help you set up the content store on Oracle:
Ensure that the parameter for the database instance compatibility level of the
content store database is set to 9.0.1 or higher.
For example, you can check the COMPATIBLE initialization parameter setting by
issuing the following SQL statement:
SELECT name, value, description FROM v$parameter WHERE
name=compatible;
For information about changing an instance configuration parameter, see the Oracle
documentation.
Determine if the database is Unicode.
Tip: One method is to type the following select statement:
select * from NLS_DATABASE_PARAMETERS
If the result set returns an NLS_CHARACTERSET that is not Unicode, create a new
database and specify AL32UTF8 for the database character set parameters.
Determine which user account will be used to access the database.
Ensure that the user account that accesses the database has permission to do the
following:
connect to the database
create, alter, and drop triggers, views, procedures, and sequences
create and alter tables
insert, update, and delete data in the database tables
Your database administrator must back up DashInsight databases regularly because
they contain the IBM Cognos data. To ensure the security and integrity of databases,
protect them from unauthorized or inappropriate access.

Suggested Settings for Creating the Content Store in Microsoft SQL

Server
The database you create for the content store must contain the specified configuration
settings.
To ensure a successful installation, use the following guidelines when creating the
content store.
Use the same guidelines to create a database for log messages.

3 4
Use the following checklist to help you set up the content store on Microsoft SQL Server:
Ensure that the collation sequence is case-insensitive.
In a Custom installation, you choose a collation, which includes character sets
and sort order, during the Microsoft SQL Server setup. In a Typical installation, the
installation uses the locale identified by the installation program for the collation. This
setting cannot be changed later.
When connecting to Microsoft SQL Server Management Studio to create the
database, use Microsoft SQL Server authentication.
For the user account that will be used to access the database, create a new login
under Security and use the following settings:
Select SQL Server authentication.
Clear the Enforce password policy check box.
For Microsoft SQL Server 2008, grant EXECUTE permission to the user account that
accesses the database.
For the DashInsight content store database, create a new database under
Databases.
Under Security for the new database, create a new schema and assign a name to it.
Under Security for the new database, create a new user with the following settings:
For Login name, specify the new login that you created for the user account.
For Default schema, specify the new schema.
For Owned Schemas, select the new schema.
For Role Members, select db_datareader, db_datawriter, and db_ddladmin.

Suggested settings for DashInsight content store database and

user names
Database name: DashInsightCS
Database username: DashInsightCS

Database connectivity for the IBM Cognos Content Store

To query the IBM Cognos metadata (such as groups, users, roles, and public folder
content), DashInsight requires to have a database connection to IBM Cognos Content
Store database.
To support communication between DashInsight and IBM Cognos Content store
database you must have a valid database user that has data read access to IBM
Cognos Content Store database.

10

3 4

Installing DashInsight Content Store on the same database with

IBM Cognos Content Store
If the DashInsight content store database is installed on the same database server/
instance as the IBM Cognos content store database, you can use the DashInsight
database user to access the IBM Cognos content store, as well. In this scenario you
need to grant data read access to DashInsight database user over the IBM Cognos
Content store database.

Installing DashInsight Content Store on a different database than

IBM Cognos Content Store
If the DashInsight content store database is installed on a different database server/
instance than the IBM Cognos content store database, you need to create a Database
User that has data read access over the IBM Cognos Content Store database.

11

3 4

Installing DataClarity DashInsight software

DataClarity DashInsight can be installed on a single server (Gateway and Application
components together), or on multiple servers (Gateway and Application components
installed on different servers).
Three installation packages are available for any of the configurations below:
DashInsight Single Server installation package (installs all components on one
server)
DashInsight Gateway installation package (installs only the Gateway component)
DashInsight Application installation package (installs only the Application
component)
To install any of the above configurations, you should follow the steps:
Run DashInsight Setup.exe to start the installation wizard.

Click Next button to start the installation process. Review the Software License
Agreement and click I accept the terms of the License Agreement.

12

3 4
On the Enter Serial Number screen you will be asked to enter a valid DashInsight
Serial Number. To continue the installation, you must enter a valid serial number
provided by DataClarity.

13

3 4
Enter the serial number, and then click Next. On the next screen you will see the
available DashInsight installation components. Based on what installation package
you have selected for this installation, one of the following options will be available:
DashInsight Gateway and Application, DashInsight Gateway, or DashInsight
Application.

14

3 4
Select the configuration option and click Next. Choose the location where the
DashInsight software will be installed, and then click Next.

Specify the location and the name of the product shortcuts and click Next.

15

3 4
Specify what IBM Cognos BI components are already installed on this server and
click Next.

Specify the location where IBM Cognos software is currently installed and click
Next.

16

3 4
Review the installation summary settings and click Install

Wait for the installation to be completed.

17

3 4
If the installation is successfully completed a confirmation message will be
displayed. Click Done to close the installation wizard.

18

3 4

Importing DashInsight Content

To import the DashInsight package and sample dashboards content into IBM Cognos
BI, the following steps are required:
In IBM Cognos Connection, in the upper-right corner, click Launch, IBM Cognos
Administration.
On the Configuration tab, click Content Administration.
On the toolbar, click the New Import button.
The New Import wizard appears.
Select DataClarity DashInsight package and then click Next.
Enter the password DashInsight, and then click OK.

19

3 4
Specify a name and location for the deployment.

Select the DashInsight folder and options to include in the report and then click
Next.

20

3 4
Select the Directory content page, options to include in the report and then click
Next.

In the Specify the general options page, select whether to include access
permissions and references to external namespaces, who should own the entries
after they are imported and then click Next.

21

3 4
The summary information appears. Review the summary information and click
Next.

Select Save and run once, and then click Finish.

22

3 4
You can select when you want to run the import. After your selection click Run.
Select the View details of this import after closing this dialog option and click OK.

If the import has finished successfully then you see this message CM-REQ-2300 Import
is complete. Object(s) were imported. 0 object(s) failed.
From your home screen of Cognos Connection you should be able to see the
DashInsight folder.

23

3 4

Configure Microsoft IIS

Introduction
DashInsight requires that Microsoft IIS 7.0 has previously been added to the server,
and that all necessary options have been selected to successfully run a website. Also
assume that the DataClarity DashInsight Gateway components have been successfully
installed.

Install Microsoft IIS ARR component

DashInsight IIS Configuration requires the IIS ARR (Application Request Routing) module
to be installed. If the ARR module is not already installed, the component installation can
be found at:
http://www.iis.net/downloads/microsoft/application-request-routing
Note: After installing the IIS ARR component, close and reopen the IIS Management tool.
The new ARR component should be added under the ISS section.

Enable Application Request Routing Cache and Server Proxy

Open the Internet Information Services (IIS) Manager and select the computer name
on the left.
Select Features View.
Double click on Application Request Routing Cache.

24

3 4
Click Server Proxy Settings.

Select the Enable Proxy checkbox.

25

3 4

Setup proxy redirect to DashInsight Tomcat

Open Internet Information Services (IIS) Manager and select the computer name on
the left.
Select Features View.
Double click on URL Rewrite.

Click Add rule(s) and under Inbound rules select Blank rule.

Enter DashInsight into the Name field.

Select Matches the Pattern from the Requested URL dropdown box.
Select Regular Expressions from the Using dropdown box.
Enter (DCBusinessSuite.+) in the Pattern field and select the Ignore case
checkbox.
Select Rewrite from the Action type dropdown box.

26

3 4
Enter http://localhost:8080/{R:0} in the Rewrite URL field and select the Append
query string checkbox.
Note: The localhost and 8080 should be updated accordingly based on DashInsight
Tomcat configuration settings.

Restart Microsoft IIS services.

27

3 4

Configure and Start DashInsight Services

To configure and start the DashInsight Services the following steps are required:
In Microsoft Windows, from the Start menu, click Programs > DataClarity DashInsight >
DashInsight Configuration. If you are using a Windows Vista, Windows 7, Windows 2008,
or Windows 2012 computer, and have installed the product to the Program Files (x86)
directory, start DataClarity DashInsight Configuration as an Administrator.
The DashInsight Configuration interface includes the following components:
1. Explorer window
2. Properties window
3. Variable help window
4. Service status information
5. Toolbar Actions (Save, Start Service, Stop Service, Restart Service, Reset Variables,
Test Configuration)

Setup database connectivity for the content store databases

If you are using a database other than Microsoft SQL Server as the content store, you
may have to install database client software, or Java Database Connectivity (JDBC)
drivers, or both, on each computer where you install DataClarity DashInsight. Additional
jdbc drivers can be found in <installation location>/DashInsight/libs folder.

28

3 4
Two database connections are required to be defined:

DashInsight Content Store Database

DashInsight Content Store database stores metadata specific to DashInsight (portals
and user communities, bookmarks, snapshots, discussion threads, insights, and
notifications).

IBM Cognos Content Store Database

Specific IBM Cognos information related to users and groups are pulled directly from
the Cognos Content Store database. No updates are performed over this database, a
database user with read access is required only.
In the Explorer window click DashInsight and/or IBM Cognos under the Content Store
folder and enter the required connection information in the variable properties window.
After the connection information is entered, the database connectivity can be tested.

Configure environment properties

In the Explorer window click DashInsight and/or IBM Cognos under the
Environment folder and enter the required URI information in the variable
properties window.

29

3 4

DashInsight URI variables

In the Gateway root URI specify the base URL for DashInsight web (server and port)
In the App Server URI(s) specify one or multiple DashInsight Application servers
(server, port, and web application name)
If multiple DashInsight application servers are available, the load balancing can be
configured as either First Available, Round Robin. In case of Round Robin a
different weight can be configured for each application server.

IBM Cognos URI variables

In the Gateway URI specify the full IBM Cognos Gateway URI.
In the Gateway URI (mobile) specify the full IBM Cognos Gateway URI that is used
for Mobile devices (use the value specified in the Gateway URI if both Web and
Mobile will use the same gateway)

In the Dispatcher URI specify the IBM Cognos Dispatcher URI.

In the Dispatcher URI (mobile) specify the IBM Cognos Dispatcher URI that is used
in conjunction with the IBM Cognos Gateway URI for mobile devices (use the value
specified in the Dispatcher URI if both Web and Mobile will use the same gateway)

30

3 4
In Other Dispatcher(s) specify any other IBM Cognos dispatchers available.

Configure Windows Service for DashInsight

In the Explorer window click DashInsight under the DashInsight Services folder
and enter the required information into the Properties window.
In the Windows service name specify the name for the Windows service. No
spaces are allowed for the name.
In the Shutdown port specify the Tomcat shutdown port.
In the HTTP port specify the Tomcat HTTP port.

31

3 4
In the AJP port specify the Tomcat web AJP connector.

Save and Start Windows Service for DashInsight

To save the configuration settings click Save action item from Toolbar menu or
Save from File menu.

32

3 4
To start the Windows service click Start action item from Toolbar menu or Start
from Actions file menu.
If the Windows Service is successfully started the status bar will be update
accordingly.

Validate the Configuration Settings

To validate the DashInsight configuration settings click Test icon from the toolbar or
Test Configuration from Actions file menu.

33

3 4

Create DashInsight Content Store Objects

To create the DashInsight Content Store objects the following steps are required:
Open DashInsight Content Manager URL into a web browser. Use http://localhost/
DCBusinessSuite/ContentManager where localhost is the name or IP address that
was configured for DashInsight Gateway URI in the Configuration client.
Enter the Content Manager username and password defined in Configuration Client.
Or enter the default ContentManager and cHacU86t for username and password
if these variables have not been changed during the DashInsight configuration.

Select Manager tab and click Install. If database objects are successfully
created, the Information panel will be updated accordingly

34

3 4
Select DashInsight tab and click Install.
If database objects are successfully created, the Information panel will be updated
accordingly.
Click Update toolbar icon. If database objects are successfully updated, the
Information panel will be updated accordingly.

35

3 4
Installation / Configuration Notes:

800.963.5508

www.DashInsight.com
www.CognosMobile.com
www.DataClarityCorp.com