atg customer intelligence installation and configuration

Business Intelligence

Version 2007.3

Installation and Configuration Guide

Oracle ATG

One Main Street

Cambridge, MA 02142

USA

ATG Customer Intelligence Installation and Configuration Guide

Product version: 2007.3

Release date: 04-15-11

Document identifier: AciInstallationGuide1106061639

Copyright © 1997, 2011 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are

protected by intellectual property laws. Except as expressly permitted in your license 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. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of

the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS

Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial

computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific

supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and

license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the

additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle

Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended

for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures

to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are

trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or

registered trademarks of Advanced Micro Devices. UNIX is a registered trademark licensed through X/Open Company, Ltd.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties.

Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party

content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to

your access to or use of third-party content, products, or services.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/us/

corporate/accessibility/index.html.

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/

contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

ATG Customer Intelligence Installation and Configuration Guide iii

Table of Contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2. ATG Customer Intelligence Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Report Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Architecture Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

ACI Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

ACI Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

ATG Reporting Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Modeling Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Additional Reporting Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

ACI Software Development Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Using ACI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3. Installing ACI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Installing ATG Customer Intelligence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Download and Install ACI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuring the JVM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configure the Web Server for ACI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Prepare for Creating the Content Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Configure the Reporting Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Configuring Multiple Custom Authentication Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuring the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Create ACI Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Import Role Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Create Platform Data Warehouse Tables: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Create the Loader Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Create the Metadata Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Import Reports and Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Modify the Default Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Running ATG Customer Intelligence Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Accessing ATG Customer Intelligence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

ATG Business Control Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

ATG Business Control Center Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

ATG Service Applications/ATG Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4. ACI Access Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Assigning Roles and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Assigning ACI Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Viewing Users and Roles in the Reporting Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Viewing and Modifying Reporting Center Capability Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Viewing and Modifying Reporting Center Object Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Default Access Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

5. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

iv ATG Customer Intelligence Installation and Configuration Guide

1 Introduction 1

1 Introduction

This guide provides an overview of ATG Customer Intelligence and its components. It includes instructions for

installing ATG Customer Intelligence (ACI) on the following system configuration:

Operating System Win 32

Web Server IIS

Reporting Database MS SQL (Data Warehouse)

Content Store Databases MS SQL

For installing on this and other configurations, you may also want to refer to the Cognos 8 Business Intelligence

Installation and Configuration Guide.

Note: Availability of the studio applications and documents described in this guide depend on your licensing

permissions and ATG installation(s). References in this guide to additional documentation, studios, applications,

sample material, and tools may not be applicable to your ATG Customer Intelligence (ACI) installation. Please be

sure to follow instructions and guidelines specific to your installation. For questions regarding your installation,

or to change your licensing permissions, see your administrator.

This chapter includes the following sections:

Audience (page 1)

Documentation Conventions (page 2)

Related Documents (page 2)

Audience

To use this guide, you should be familiar with:

• Reporting concepts

• Database and data warehouse concepts

• Security concepts

2 1 Introduction

• Windows and/or UNIX administration

• Existing server environment and security infrastructure in your organization

Documentation Conventions

The following conventions are used throughout the documentation:

Convention Explanation

Italics Introduces new terms and indicates emphasis.

Bold Emphasizes important information, or indicates field names, menu items, or button

names.

monospace Indicates syntax examples, values that you specify, or results that you receive.

Brackets [ ] Indicates optional items. For example, in the following statement: SELECT

[DISTINCT], DISTINCT is an optional keyword.

The directory where you installed ACI 2007.3 is identified as <ACI2007.3Dir>.

Related Documents

For information on supported platforms and product combinations, see the Supported Environments page on

the ATG Web site (http://www.atg.com/en/products/requirements/).

The following guides are available:

Document Contains Information About

ATG Reporting Center User Guide Accessing and running reports using the Reporting Center.

ATG Report Studio User Guide Creating complex, fully formatted reports using Report Studio.

ATG Customer Intelligence Data

Warehouse Guide

Database structure and metadata that can be used for reports.

Cognos documentation is available at the following locations once you have installed ACI:

• Reporting Server Documentation:

http://www.atg.com/en/products/requirements/

1 Introduction 3

<ACI2007.1>\c8\webcontent\documentation\crn_mtoc.html

• Framework Manager Documentation:

<ACI2007.3>\c8\webcontent\documentation\fm_mtoc.html

• SDK Documentation:

<ACI2007.3>\c8\webcontent\documentation\sdk_mtoc.html

4 1 Introduction

2 ATG Customer Intelligence Overview 5

2 ATG Customer Intelligence

Overview

ATG Customer Intelligence (ACI) helps you make better decisions by providing a deeper understanding of your

organization. Use ACI components to view or create business reports related to your internal and external

customer interactions.

The following ATG applications are delivered with pre-configured reports and dashboards for use with ACI:

• ATG Knowledge

• ATG Commerce

• ATG Outreach

• ATG Search


Report Features (page 5)

Architecture Overview (page 6)

ACI Security (page 7)

ACI Components (page 8)

Using ACI (page 11)

Report Features

ATG Reporting is a multilingual solution that lets you author reports once and deploy them globally. When users

open a report, it automatically opens in the proper language, based on their locale settings.

You can select the language that you prefer for the user interface. If your data and reports are available in

multiple languages, you can also select the language that you prefer for the content.

To deliver multilingual content, you can create each entry with multilingual properties in the appropriate studio.

ACI reports can be output in the following formats:

6 2 ATG Customer Intelligence Overview

• HTML

• PDF

• Excel

• CSV (delimited text)

• XML

If you are the owner of a report or have the necessary permissions, you can specify the default format for each

report. You can also specify how many report output versions to keep.

When you view report data in the Reporting Center, Query Studio, and Analysis Studio, you may be able to drill

down or up through information to view it at a more or less detailed level.

ACI also supports ad hoc querying, and the ability to join display reports as dashboards, providing quick analysis

of multiple information streams.

Architecture Overview

This section describes the databases and other major components involved in an ATG Customer Intelligence

installation, and their relationships to one another.

A typical ACI installation has the following components:

• ATG Customer Intelligence—See the ACI Components (page 8) section of this chapter for a description of

the tools that comprise ACI. The ACI software runs in a separate JVM from other ATG applications.

• Content Store—Contains data used for the operation of the ATG Reporting Framework. The content store is

used to store reports, queries, schedules, folders, packages, and metrics.

• ATG Reporting Data Warehouse (ATGDW)—Contains data from ATG applications used to report and query on.

The data in the data warehouse is subject oriented, integrated, informational, non-volatile, and time variant.

The warehouse is optimized for query processing

• ATG applications—Applications such as ATG Knowledge and ATG Commerce provide information that is

stored in the ATGDW. These applications load data into the warehouse from a variety of operational data

sources.

• ATG application data loaders—These modules load application data into the data warehouse. They are

installed as part of the related ATG application, and run in a separate JVM from the application for better

performance. In a production environment, these should be run on a dedicated machine.

• Web server—Processes requests and sends them to the application as appropriate.

The following diagram shows these items in relationship:


ACI Security

By default, authentication for ACI is performed by the ATG Custom Authentication Provider, which works with

the Web Services for Cognos Authentication Provider (WSCAP) Web service. These two components manage

communication between ATG Customer Intelligence and the ATG user directory, which contains user login

information, roles, permissions, and other data used to authenticate and authorize users. ACI can then use the

information in the user directory to authenticate attempted logins.

If you do not want to use the ATG Custom Authentication Provider, you can create your own authentication

component; see the Custom Authentication Provider SDK Developer Guide for information.

The following diagram shows the components involved in authentication:


ACI Components

This section describes the components that make up ATG Customer Intelligence, and some of the features they

provide. Additional documentation is available for many of these components; contact your administrator for

information.

ATG Reporting Center

Reporting Center is the Web portal for ACI, and is the starting point to access report authoring and scheduling

tools, access permissions, and interface personalization. You can use the Reporting Center to:

• View, organize, and publish your organization’s ACI content

• Create and run reports and distribute reports

• Create shortcuts, URLs, and pages, and to organize content

• Personalize ATG Reporting Center

• Access Query Studio and Report Studio

• Administer servers, optimize performance, and set access permissions for ACI reporting studios and tools

(administrators)

Note: For information about Reporting Center, see the ATG Reporting Center User Guide. For information about

ACI administration, see the Cognos Administration and Security Guide.

The Reporting Center includes the following features:


• Public Folders—Entries in Public Folders are shared and utilized by many users and are grouped by folders or

packages. You can track your location within the folder hierarchy and navigate through the folders by using

the path located under the folder tabs.

• Personal Folders—Personal folders contain your personal reports and can be organized into folders as you

require. Your personal folders are not accessible by other users.

• Report Views—If you want to personalize an existing public report, you can create a report view and save the

view in the My Folders tab. This allows you to make changes such as save prompt values, modify the schedule,

and change the output format of reports.

• Dashboard—A customizable page that can contain those reports you want to access quickly and at a glance.

Users have the option of choosing the reports to display at the time of installation.

• Portal Pages—Create portal pages to view frequently-used content, to group related reports and folders, and

to combine content within a single page. Within your portal pages, you can add portlets, which you use to

view and interact with your ACI content.

If you have the necessary permissions, you can create public pages that other users and groups can access

and even use as their own. You can assign security permissions to allow only certain users to access the pages.

• Scheduling—You can schedule the following Reporting Center content to run at a time that is convenient for

you:

• Reports

• Deployments

You can also create jobs to schedule multiple entries together.

Modeling Components

Modeling components structure and present data in a way that is meaningful to users. Modeling components

include the following tools:

• Framework Manager—Use to create and manage business-related metadata for use in ACI analysis and

reporting. Metadata is published as a package, providing a single, integrated business view of any number of

heterogeneous data sources, which can then be used by other reporting tools.

• Map Manager—Administrators and modelers use this Windows utility to import maps and update labels for

maps in Report Studio. For map features such as country and city names, administrators and modelers can

define alternative names to provide multiple versions of text that appears on the map. For information about

using Map Manager, see the Map Manager Installation and User Guide.

Additional Reporting Components

The tools described in this section provide user interfaces for reporting and analysis, as well as server

functionality for routing and processing user requests. These components include the following:

• Report Studio—Lets report authors create, edit, and distribute a wide range of professional reports. They can

also define corporate-standard report templates for use in Query Studio, and edit and modify reports created

in Query Studio or Analysis Studio. ATG Report Studio provides powerful functionality, such as bursting,

prompts, and advanced charting, and provides many ways to customize reports. Unlike Query Studio, when

you use Report Studio, data is not immediately visible. You must run the report to view current data.


For more information and instructions about Report Studio, see the ATG Report Studio User Guide.

• Query Studio—An ad-hoc reporting tool that lets users quickly design, create and save reports to meet

reporting needs not covered by the standard, professional reports created in Report Studio.

For more information and instructions about Query Studio, see the ATG Query Studio User Guide.

• Analysis Studio—Allows business users to explore, analyze, and compare dimensional data. Users can quickly

analyze critical corporate data from any angle to find trends, understand why business events occur, and then

make effective decisions. Analysis Studio provides access to dimensional, online analytical processing (OLAP),

and dimensionally modeled relational data sources. Analyses created in Analysis Studio can be opened in

Report Studio and used to build professional reports.

• Event Studio—Users can set up agents to monitor data and perform tasks when business events or

exceptional conditions occur. Agents can publish details to the portal, deliver alerts by email, run and

distribute reports based on events, and monitor the status of events. For example, a support call from a

key customer or the cancellation of a large order may trigger an event, sending an email to the appropriate

people.

• Metric Studio—Users can create and deliver a customized scorecarding environment for monitoring

and analyzing metrics throughout your organization. Users can monitor, analyze, and report on time-

critical information by using scorecards based on cross-functional metrics. This can shows you where your

organization is successful and where it needs improvement. It tracks performance against agreed targets and

indicates the current status so that decision makers at every level of the organization can react and plan.

• Cognos Configuration—A tool used to configure ATG Customer Intelligence, and to start and stop its services.

• Report Viewer—A portlet in which you can view and interact with any type of published ATG Customer

Intelligence content. It is accessible through Reporting Center and any existing enterprise portal.

• Content Manager—The ATG Customer Intelligence service that manages the storage of customer application

data, including security, configuration data, models, metrics, report specifications, and report output. Content

Manager is needed to publish models, retrieve or store report specifications, manage scheduling information,

and manage the ACI namespace. Content Manager stores information in a content store database.

• Composite Information Server—Provides access to additional data sources such as LDAP, JDBC, Open XML

and WSDL, and improves performance when querying data from different data sources.

ACI Software Development Kit

The software development kit (SDK) provides a platform-independent automation interface for working with

ACI services and components. Developers in your organization can use the SDK to create custom reports,

manage deployment, and integrate security and portal functionality to suit your needs, locale, and existing

software infrastructure. The SDK uses a collection of cross-platform Web services, libraries, and programming

interfaces.

You can choose to automate a specific task, or you can program the entire process from modeling through to

reporting, scheduling, and distribution

For more information, see the documentation available at:

<ATG2007.3dir>\ACI2007.3\c8\webcontent\documentation\sdk_mtoc.html


Databases

In addition to the tools previously described, ATG Customer Intelligence uses the following databases:

• Content Store—A relational database that contains data that ACI needs to operate, such as report

specifications, published models, and the packages that contain them; connection information for data

sources; information about the external namespace, and the namespace itself; and information about

scheduling and bursting reports. Design models and log files are not stored in the content store. The ACI

service that uses the content store is Content Manager.

• Metric Store—A relational database that contains content for metric packages. A metric store also contains

Metric Studio settings, such as user preferences. More than one metric store may be created. For example, one

metric store may contain content for a sales application and another metric store may contain content for a

finance application.

• ATG Data Warehouse—A relational database optimized for handling reporting queries. ATG Customer

Intelligence uses two different methods to connect to the ATG data warehouse.

• In ATG applications, reporting summarization modules use the /atg/reporting/datawarehouse/

FakeXADataSource component to save the data to the data warehouse.

• To retrieve report data from the data warehouse, ATG Customer Intelligence uses the ATGDW data

source configured in the ATG Reporting Center (see the ATG Reporting Center User Guide for configuration

information).

Using ACI

This section briefly describes some typical activities involved in using ACI, the components involved, and the

types of users who perform them. Examples of possible user types are identified in italics; your business may

have a different division of responsibilities.

In working with reports, the following steps are common:

1. In Framework Manager, the modeler ensures that metadata is presented in a manner that business users can

understand. Modelers import metadata from one or more databases, and then add to the model to meet

their users’ requirements.

A model structures, adds to, and manages data in ways that make sense to business users. Planning and

creating a model is an important task that should be performed by people familiar with both the database

structure and the needs of the business users.

For information about data modeling, see the Framework Manager User Guide.

2. The modeler then publishes the metadata to the Reporting Center in the form of packages.

A package contains all the data required to meet the needs of the intended users. For example, one package

can contain human resources data, and another sales data. When users open an authoring studio, they must

select which package to use.

Note: Each report can contain data from only one package.

3. Business users and report authors use the published packages to understand their business data, and to create

reports in the Query Studio or Report Studio.


Note: When authors create a “report,” they are actually creating a report specification. The report

specification is an XML representation of the queries and prompts that are used to retrieve data, as well as the

layouts and styles used to present the data. For information about working with report specifications, see the

ATGReport Studio User Guide.

4. Report users run, view, and manage their content in the Reporting Center.

3 Installing ACI 13

3 Installing ACI

This installation guide covers installing ATG Customer Intelligence (ACI) on the following configuration:

Operating System Win 32

Web Server IIS

Reporting Database MS SQL (Data Warehouse)

Content Store Databases MS SQL

For complete information on ATG supported environments, see the Supported Environments page on the ATG

Web site (http://www.atg.com/en/products/requirements/).

This chapter provides an example of how to install ACI on a relatively simple system configuration. For complex

installations, or for installing on other configurations, refer to the Cognos 8 Business Intelligence Installation and

Configuration Guide.


Before You Begin (page 13)

Installing ATG Customer Intelligence (page 14)

Configuring the Database (page 17)

Accessing ATG Customer Intelligence (page 20)

Before You Begin

Be sure that the following tasks are complete before starting your ACI installation:

• Install the Web server

• Install the database software

• Install ATG 2007.3 on your preferred application server

Note: ACI and the ATG Business Control center must use the same Web server instance. All ACI users must set

their browser preferences to accept cookies.

http://www.atg.com/en/products/requirements/

14 3 Installing ACI

Note: For the configuration described in this guide, ATG and your application server should be configured to

run with IIS. For installing on other configurations, refer to the Cognos 8 Business Intelligence Installation and

Configuration Guide.

Installing ATG Customer Intelligence

This section describes the steps involved to install and perform initial configuration for ACI. For additional

information, see the Cognos 8 Business Intelligence Installation and Configuration Guide.

Download and Install ACI

1. Download the ACI installer and start the installation.

Note: ATG Customer Intelligence must run on the same HTTP server as your ATG 2007.3 installation.

2. Accept the license agreement.

3. Enter the Installation Location, and click Next.

4. Select the Installation Set, and click Next. Installation includes:

• Reporting Server (required for all users)

• Framework Manager (required for modeling users )

Note: Framework Manager can only be installed on Windows.

• SDK (required for development environment users )

5. Choose a Shortcut Folder for the location of the product icons, and then click Next.

6. Verify the Pre-Installation Summary information, and then click Install.

3 Installing ACI 15

7. After the installation is complete, click Done.

Configuring the JVM

To use ATG Customer Intelligence, you must have a version 1.5 JVM installed. You will need to add some security

extensions to this JVM before using ACI.

1. Copy the specified .jar files to your 1.5 JVM’s jre\lib\ext and jre\lib\security folders if they are not already

present:

<ATG9dir>\ACI2007.3.0\c8\bin\jre\1.4.2\lib\ext\bcprov-jdk13-125.jar

<ATG9dir>\ACI2007.3\c8\bin\jre\1.4.2\lib\security\local_policy.jar

<ATG9dir>\ACI2007.3.0\c8\bin\jre\1.4.2\lib\security\

US_export_policy.jar

2. Make sure that your JAVA_HOME variable is set to the 1.5 JVM.

Note: Cognos 8 requires Sun Java in order to run on Linux. Using the Oracle JVM will result in startup errors.

Configure the Web Server for ACI

Create virtual directories as described in the “Configure the Web Server” section of the Cognos 8 Business

Intelligence Installation and Configuration Guide. For all instances of cognos8 in the aliases described there, use

arc instead.

Note: ATG Customer Intelligence must run on the same Web server as the ATG Business Control Center.

Note: You must add /wscap as a Dynamo path prefix to your web server configuration to use the Web services

authentication module (see the ACI Security (page 7) section of this guide).

16 3 Installing ACI

Prepare for Creating the Content Store

The Content Store is a database that contains ACI operational data such as report specifications, published

models, and the packages that contain them. See the Cognos 8 Business Intelligence Architecture and Planning

Guide for information.

In this step, create a database. The tables and data in the Content Store are created by the Cognos Service when

it first starts up; you do not need to create those.

Configure the Reporting Server

In this step, you configure the Cognos Service and application security.

1. From the Start menu, select Programs > ACI2007.3 > Cognos Configuration.

2. In the Cognos Configuration Explorer pane, open Data Access > Content Manager > Content Store.

3. In the Content Store provide the following:

• User ID and Password

• Database Name

This information should match the database information created in Content Store configuration.

Note: If you are not running SQLServer on the same machine, you will also need to provide the server and

name and port for your database.

4. To verify the database information, right-click Content Store, and then click Test. Verify the database

connection exists without errors.

Note: If running IIS in a port other than 80, you need to change port 80 for the URLs to match your IIS port.

Under Local Configuration> Environment. Gateway URI and Controller URI for gateway. Example: http://

localhost:80/arc/controllerServer.

Note: If the Web server is not running locally, you must also change the host name.

5. In <ACI2007.3>/c8/configuration/AuthenticiationProvider.properties

WSCAPSOAPAddressString=http://hostname:port/wscap/services/wscapSOAP

Note: Host and port numbers should be set where your WSCAP authentication provider is set. You must add

/wscap as a Dynamo path prefix to your web server configuration.

6. Save your configuration changes.

7. Start Cognos Service:

• From the Actions menu, click Start (or from the toolbar, click the Start button).

• Verify that the service runs without errors.

• Open your browser to http:/hostname:port/arc to verify that the login page displays.

3 Installing ACI 17

Configuring Multiple Custom Authentication Providers

If you have two ATG instances pointed at a single ACI installation, each ATG instance can use different custom

authentication provider properties.

First, use Cognos Configuration to register and add a new namespace:

1. Start Cognos Configuration.

2. Navigate to Security >Authentication.

3. Right-click Authentication and select New resource > Namespace....

4. Provide a name for the namespace. Set the type to Custom Java Provider. Set the Java class name to

atg.cognos.security.AuthenticationProvider. Set the namespace ID property to a unique id for this

namespace.

Then create a new AuthenticationProvider.properties file. The <ATG2007.3dir>\ARF\WSCAP

\config\atg\cognos\AuthenticationProvider.properties file is used when there is only one custom

authentication provider. To configure multiple providers, copy the existing file and name the new file:

AuthenticationProvider_namespaceID.properties

where namespaceID represents the namespace ID of the authentication provider as configured in Cognos

Configuration. Add one such configuration file for each custom authentication provider you want to access your

ACI installation.

See the Custom Authentication Provider SDK Developer Guide for additional information on authentication.

Configuring the Database

This section contains steps pertaining to database setup and configuration for your ACI installation.

Create ACI Data Source

This step creates the ATGDW Reporting Center data source, which is used to connect to the ATG data warehouse.

Configuration information may differ depending on your database vendor; the steps that follow assume you are

using the SQL native data source.

As a prerequisite to this step, you must have the Microsoft SQL Server client installed.

Note: A Reporting Center data source is not the same as an ATG datasource component.

To create the data source:

1. Go to the ATG Reporting Center and log in as the administrator :

User name: admin

Password: admin

2. From the Reporting Center, go to: Tools>Directory, and then click the Data Sources tab.

18 3 Installing ACI

3. From the Data Sources tab, click the New Data Source button.

4. From the New Data Source page, type the name for the new data source:

Name: ATGDW

Note: You must use ATGDW as the name for the data source. Additional information (such as Description) is

optional.

5. Click Next.

6. Select the Type of Data Source. For example: Microsoft SQL Server (SQL Native Client)

7. Click Next.

8. Provide the Server Name and Database Name.

9. Under Signons, select Signons and if desired, provide a User ID and Password. This will allow automatic

login to the database for all users. Credentials entered here should be the same as those created for your data

warehouse.

10.Under Testing, click the Test the connection link.

11.From the Test the Connection page, click the Test button. Verify that the test completes successfully, and then

click Close.

12.Click Finish.

Import Role Information

This step imports the default roles, groups, and permissions into your profile repository. If you have other ATG

applications installed, such as ATG Service, the data imported in this step may already exist in your ATG system.

Re-importing the roles may cause errors. Check your system and your application documentation.

From a command prompt, import the arf-profile.xml to the profile repository. To import roles into the

external user repository (also sometimes called the Profile Adapter Repository):

<ATG2007.3dir>/home/bin/startSQLRepository -m BIZUI -import <ATG2007.3dir>/ARF/BIZUI/data/arf-profile.xml

To import roles into the internal profile repository:

<ATG2007.3dir>/home/bin/startSQLRepository –m PubPortlet –repository/atg/userprofiling/InternalProfileRepository –import<ATG2007.3dir>\ARF\BIZUI\data\arf-profile.xml

Note that you should only import the latter roles into the InternalProfileRepository accessed by your Content

Administration server or servers.

Create Platform Data Warehouse Tables:

Data warehouse tables can be housed in any database in your system. For performance reasons, you may want

to dedicate one or more databases for the purpose. Regardless of which database is used, the data warehouse

must reside in a separate schema from other ATG data.

3 Installing ACI 19

For your data warehouse database, run the following SQL scripts in the order shown:

<ATG2007.3dir>/ARF/DW/base/sql/db_components/<db name>

If you are using internal users, run the following:

<ATG2007.3dir>/ARF/DW/InternalUsers/sql/db_components/<db name>

Create the Loader Schema

Run the following scripts in the order shown:

<ATG2007.3dir>/ARF/DW/base/sql/db_components/<db name>/arf_loader_ddl.sql

<ATG2007.3dir>/ARF/DW/base/sql/db_components/<db name>/arf_if_generator.sql

Create the Metadata Model

If you intend to use more than one reporting application together, you will need to create a combined metadata

model. To create the model, run the platform action logs, then the action logs for your application(s). See the

Framework Manager User Guide for more information.

The platform action logs should be executed in the order shown:

• <ATG2007.3dir>/ARF/DW/base/cpf/01InitializeModel.xml

• <ATG2007.3dir>/ARF/DW/base/cpf/02DatabaseView.xml

• <ATG2007.3dir>/ARF/DW/base/cpf/03ModelView.xml

• <ATG2007.3dir>/ARF/DW/base/cpf/04DimensionalView.xml

The internal user action logs should be executed in the order shown:

• <ATG2007.3dir>/ARF/DW/InternalUsers/cpf/01InitializeModel.xml

• <ATG2007.3dir>/ARF/DW/InternalUsers/cpf/02DatabaseView.xml

• <ATG2007.3dir>/ARF/DW/base/InternalUsers/cpf/03ModelView.xml

• <ATG2007.3dir>/ARF/DW/base/InternalUsers/cpf/04DimensionalView.xml

Then run the action logs for your application. For example, for ATG Knowledge, run the following:

• <ATG2007.3dir>/Service2007.3/Service/KnowledgeDataWarehouse/cpf/02DatabaseView.xml

• <ATG2007.3dir>/Service2007.3/Service/KnowledgeDataWarehouse/cpf/03ModelView.xml

20 3 Installing ACI

• <ATG2007.3dir>/Service2007.3/Service/KnowledgeDataWarehouse/

cpf/04DimensionalView.xml

Import Reports and Metadata

See your ATG application guides for information on importing application-specific reports.

Modify the Default Namespace

Remove the Everyone role from the Reporting Center System Administrator group to limit access to ACI.

1. Start the Web application that includes the ATG Reporting Center.

2. From the Reporting Center Tools menu, select Directory.

3. Click the Default namespace.

4. Navigate to the System Administrator group.

5. Remove the Everyone role.

Running ATG Customer Intelligence Modules

ACI itself runs by default as an always-on Windows service. It can be stopped and restarted through the Cognos

Configuration interface, available from your Start menu.

In order to use ATG reporting, you need to compile an EAR file that includes the modules you want to use.

Include the following modules:

ARF.WSCAP ARF.BIZUI

For more information on assembling applications, see the ATG Programming Guide.

Once you have assembled your EAR file, deploy it to the appropriate location, and start your Web application

according to the instructions provided in your application server manuals.

Accessing ATG Customer Intelligence

You can access ACI from the ATG Business Control Center, from applications you access through the Business

Control Center, or from the ATG Workspace when working with ATG Service applications.

ATG Business Control Center

To access ACI from the Business Control Center: click Reporting>Launch Reporting Center.

3 Installing ACI 21

ATG Business Control Center Application

To access ACI from a Business Control Center-based application:

1. From the Business Control Center Operations menu, click the application name (for example; Service Admin).

The application page is displayed.

2. From the Utilities menu, click Reporting Center. The ACI Welcome page is displayed.

ATG Service Applications/ATG Workspace

To access ACI from the ATG Workspace, from the ATG Workspace Utilities menu, click Reporting Center.

22 3 Installing ACI

4 ACI Access Administration 23

4 ACI Access Administration

This chapter describes ACI permissions, capabilities, and roles.

Permissions control access to objects created in ACI, such as reports or folders. Every object in ACI has a

permission associated with it. These permissions control whether a user is granted or denied read, write , and/or

execute access to an object. Permissions can be granted or denied to any user, group or role.

Capabilities control actions users can perform, such as the ability to author a report using Report Studio.


Assigning Roles and Permissions (page 23)

Default Access Settings (page 26)

For additional information, see the Cognos 8 Administration and Security Guide.

Assigning Roles and Permissions

ATG roles are assigned by administrator using the ATG Business Control Center. See your application’s

documentation for information on roles and rights associated with that application.

See the ATG Business Control Center Administration and Development Guide for information on role administration.

Note: By default, the Report Viewer capability is available to the Everyone role.

Assigning ACI Roles

To assign ACI roles to internal users via the Business Control Center:

1. Log in to the ATG Business Control Center as the administrator.

2. From the Business Control Center Operations menu, click Personalization >Internal Users.

24 4 ACI Access Administration

3. From the Browse tab Show drop-down list, select Users.

4. From the Users list, click the name of the user.

5. From the InternalUser Profiles page, click the Orgs & Roles tab.

6. Click the Roles Add Existing button. The Select an item window is displayed.

Note: Users must have a Parent Organization in order to be included in the Reporting Center user directory.

Example – Business Control Center Global Roles/ATG roles

7. Select a role for the internal user from the available list, and then click OK. The selected role and organization

are displayed in the Organizations/Roles panel.

8. Click Save .

After adding an ACI role for an internal user in the Business Control Center, you can verify that the user and

role exist in the Reporting Center (see Viewing Users and Roles in the Reporting Center (page 25)).


Note: Be sure to save changes made to the user profile. Access rights will be out of date if user roles and

organizations have changed and not saved.

Viewing Users and Roles in the Reporting Center

To view users and roles in the Reporting Center:

1. Log in to the ATG Reporting Center as the administrator.

2. From the Reporting Center, click Tools > Directory.

3. From the Directory page, click a directory folder name.

4. Click a group (organization) name. User names are listed in the directory.

5. Verify that the user is listed in the user directory.

6. To view user permissions and preferences, in the Actions column, click More.

Viewing and Modifying Reporting Center Capability Permissions

To view or modify permissions set for a specific capability in Reporting Center:

1. From the Reporting Center Tools menu, click Capabilities.

2. In the Actions column, click the corresponding Set Properties button for the capability(for example; Report

Studio). The Set properties page is displayed.

3. From the Set properties page, click the Permissions tab. From the Permissions tab you can specify access

permission for the capability.


Note: See the ATG Reporting Center User Guide (“Access Permissions”) for more information and instructions

about setting permissions.

Viewing and Modifying Reporting Center Object Permissions

To view or modify object permissions:

1. From the ATG Reporting Center, click a folder or object name.

2. In the Actions column, click the corresponding Set Properties button for the object (for example; Report

Studio Template). The Set Properties page is displayed.

3. From the Set Properties page, click the Permissions tab. From the Permissions tab you can specify access

permissions for the object.

Note: See the Access Permissions section in the ATG Reporting Center User Guide for more information and

instructions about setting permissions.

Default Access Settings

The table below lists each of the components, capabilities, and/or objects, and what role a user should have to

use that item:


ACI Component/Capability/Object Roles that can use it

Report Viewer Everyone, Report Viewer, Advanced Report Viewer,

Business Report Designer, Professional Report

Designer, Reporting Metadata Designer, Reporting

Administrator

Query Studio Business Report Designer, Professional Report


Administrator

Report Studio Professional Report Designer, Reporting Metadata

Designer, Reporting Administrator

Scheduling Professional Report Designer, Reporting Metadata

Designer, Reporting Administrator

Detailed Errors Business Report Designer, Professional Report


Administrator

Administration Reporting Administrator

Analysis Studio Reporting Administrator

Event Studio Reporting Administrator

Metric Studio Reporting Administrator

Planning Contributor Reporting Administrator

Controller Studio Reporting Administrator

Specification Execution Reporting Administrator

5 Glossary 29

5 Glossary

Item Definition

access permissions Rules defining the access rights to resources. Access permissions can be

granted to any combination of namespaces, groups, or users. Examples

of resources are reports and folders.

agent The object type created and edited by Event Studio. An agent contains

the event condition and the associated tasks to perform. Once defined,

an agent can be scheduled to check for instances of the event.

authentication The process of verifying the identity of users when they log on. Users

must be authenticated before they can be authorized to use any

secured resources.

burst To create many report results by running a single report once. For

example, you can create a report that shows sales for each employee,

and run it once, sending different results to regional managers by

bursting on region. You set up bursting in Report Studio and enable it in

the portal.

contact A named email address to which reports and agent emails can be sent.

Contacts are never authenticated.

content locale A code that is used to set the language or dialect used for browsers,

report text, and so on; and the regional preferences, such as formats for

time, date, money, money expressions, and time of day. You can specify

a locale for the product interface (product locale) and for the data in the

report (content locale).

credentials Information stored about the identity of a user, usually a user name

and password. You can assign your credentials to someone else so that

they can use resources that you are authorized to use. Credentials are

created for components. If a user schedules or programs an action, then

credentials must be stored in the content store.

deployment The process of moving a Reporting application (reports, models, and so

on) to a different instance of Reporting. For example, you often create

reports in a test environment and then deploy them to production.

When you deploy an application, you export, transfer, and import it.

30 5 Glossary

Item Definition

event An exceptional item of data, defined by specifying a query expression

against items in a package. When data is detected matching the event

condition, it causes an agent to perform tasks.

group In security, a list of users or other groups that can be used to assign

access permissions and capabilities. Groups can be referenced from

third-party authentication sources or can be local to Reporting.

Local groups are managed from the administration portal. The list of

groups that an authentication user is a member of is part of the users

passport for a Reporting session. In reporting, grouping is the action of

organizing common values of query item together and only displaying

the value once. Headers and footers often appear after each instance of

a common value in a grouped column

job A group of objects, such as reports, agents, and other jobs that you run

and schedule as a batch.

locale A code that is used to set the language or dialect used for browsers,

report text, and so on; and the regional preferences, such as formats for

time, date, money, money expressions, and time of day. You can specify

a locale for the product interface (product locale) and for the data in the

report (content locale).

metric A measurement of performance in key areas of a business that

compares current results to planned values.

metric package A Reporting Center representation of a Metric Studio application. A

metric package contains connection information, reports, and metric

management tasks for that application.

model A physical or business representation of the structure of the data from

one or more data sources. A model describes data objects, structure,

and grouping, as well as relationships and security. A model, called a

design model, is created and maintained in Framework Manager. The

design model or a subset of the design model must be published to the

Reporting server as a package for users to create and run reports.

namespace For authentication and access control, a configured instance of an

authentication provider. Allows access to user and group information. In

XML, a collection of names, identified by a URI reference, which are used

in XML documents as element types and attribute names. In Framework

Manager, namespaces uniquely identify query items, query subjects,

and so on. You import different databases into separate namespaces to

avoid duplicate names.

package A subset of a model, which can be the whole model, to be made

available to the Reporting server. For Metric Studio users, see metric

package.

portlet A mechanism for displaying Web content as part of a portal page.

5 Glossary 31

Item Definition

product locale The code or setting that specifies what language, regional settings, or

both to use for parts of the product interface, such as menu commands.

publish To expose all or part of a Framework Manager model via a package to

the Reporting server, so that users can use it to create reports and other

content.

report A set of data deliberately laid out to communicate business information.

Depending on the context, “report” may refer to report specification

or report output. Report (more precisely, report specification) is the

generic term for the objects created by edited by Query Studio, Report

Studio, and Analysis Studio.

report output A report output combines data at the point in time when the report was

run with a report specification. It is a document that can be displayed,

printed or emailed. Reporting can produce report outputs in HTML, PDF,

Excel, or CSV formats.

report specification The definition of queries, prompts, layouts, and styles that make up a

report. A report specification is combined with data by a run operation

to create report outputs. You create report specifications by using

Report Studio, Query Studio, Analysis Studio, or through the Software

Development Kit.

report view A reference to another report that has its own properties, such as

prompt values, schedules, and results. You use report views to share a

report specification instead of making copies of it.

really simple syndication See rich site summary.

rich site summary An industry standard format for displaying transient data, such as

breaking news, in a web page or standalone viewer. Reporting Center

includes a portlet type for displaying RSS format data. This can be

used to display data from a public RSS service or to display news items

generated by agents detecting events. A synonym for Really Simple

Syndication.

session The time during which an authenticated user is logged on to Reporting.

user A person accessing a Reporting application. Authenticated user

definitions and information, such as first and last names, passwords,

IDs, locales, and email addresses, are maintained in third-party

authentication sources. Other user information, such as the location of

personal folders or preferred formats for viewing reports, is stored in

Reporting.

Web Services for Remote Portlets A standard for creating presentation-oriented Web services so that they

can be easily integrated within other applications, such as Web portals.

32 5 Glossary