IBM Cognos Integration Server Version 10.2.1...

IBM Cognos Integration ServerVersion 10.2.1

Administration Guide

��

NoteBefore using this information and the product it supports, read the information in “Notices” on page 113.

Product Information

This document applies to IBM Cognos Integration Server Version 10.2.1 and may also apply to subsequent releases.

Licensed Materials - Property of IBM

© Copyright IBM Corporation 2005, 2014.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1. What's new in IBM Cognos Integration Server . . . . . . . . . . . . . . 1New features in IBM Cognos Integration Server version 10.2.1. . . . . . . . . . . . . . . . . . . 1

New features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Oracle Essbase Extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Setting up an intelligent extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Oracle Essbase metadata extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Oracle Hyperion Planning data extraction . . . . . . . . . . . . . . . . . . . . . . . . . 7Oracle Hyperion Financial Management extraction . . . . . . . . . . . . . . . . . . . . . . 7Data extraction audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3. IBM Cognos Integration Server fundamentals. . . . . . . . . . . . . . . 9Starting the Integration Server Manager . . . . . . . . . . . . . . . . . . . . . . . . . . 9Integration Server Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Setting Selection Manager options . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Mapping target database table and column names . . . . . . . . . . . . . . . . . . . . . 11

The Integration Server Database Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Initializing a Microsoft SQL Server database . . . . . . . . . . . . . . . . . . . . . . . 12Initializing an Oracle database . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Initializing an SQLite database . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Initializing an IBM DB2 database . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Installing the Essbase data extractor setup tool . . . . . . . . . . . . . . . . . . . . . . . 14Setting Essbase data extractor properties. . . . . . . . . . . . . . . . . . . . . . . . . 15Setting up the Essbase data extractor manually . . . . . . . . . . . . . . . . . . . . . . 15Viewing the license key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuration file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Channel registration for Cognos Integration Server satellite servers . . . . . . . . . . . . . . . . 18HFM custom dimensions name mapping . . . . . . . . . . . . . . . . . . . . . . . . 19Data value field length in star schema fact tables . . . . . . . . . . . . . . . . . . . . . . 19Table suffixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20HFM extraction parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Password persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Fact table persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Audit table persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Fact table and column name quotation marks . . . . . . . . . . . . . . . . . . . . . . . 22Validate member selections before you run the command-line utility . . . . . . . . . . . . . . . 23Use Unicode RDBMS table format . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Maximum number of LINK arguments . . . . . . . . . . . . . . . . . . . . . . . . . 23Large data values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

The Connection Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Creating a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Enabling a Connection to use a satellite server. . . . . . . . . . . . . . . . . . . . . . . 25Testing a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Editing a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Deleting a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Cloning a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Exporting a connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Importing a Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Viewing connection uses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Connection parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

The Selection Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Creating a selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

© Copyright IBM Corp. 2005, 2014 iii

Opening a selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Deleting a selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Cloning a selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Importing a selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Exporting a selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Setting extraction options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Configuring an Essbase selection . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Planning selection configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 52HFM selection configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Searching for outline members . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Running a selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

The Log Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Filtering the log results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Viewing individual log entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Exporting the log view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

The Command Line Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Interactive mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Batch mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Command File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 4. IBM Cognos Integration Server star schema definition . . . . . . . . . . 69Star schema fundamentals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Parent-child format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Generation format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Level format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Master data management format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Essbase dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74HFM accounts dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77HFM entity dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81HFM scenario dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84HFM year dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87HFM period dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88HFM ICP dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90HFM custom1- 4 dimension table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91HFM view and value dimension tables . . . . . . . . . . . . . . . . . . . . . . . . . . 93Essbase and HFM narrow fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Essbase and HFM wide fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Planning account annotations fact table . . . . . . . . . . . . . . . . . . . . . . . . . . 96Planning cell text fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Planning form annotations fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Planning unit fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Planning supporting details fact table . . . . . . . . . . . . . . . . . . . . . . . . . . 100Audit table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Essbase filters tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Essbase users tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104HFM process management fact table . . . . . . . . . . . . . . . . . . . . . . . . . . 105HFM journal items fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106HFM journals fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107HFM cell line item details fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . 109HFM cell text fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110HFM cell history fact table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

iv IBM Cognos Integration Server Version 10.2.1: Administration Guide

Introduction

This document provides information that is intended for system administratorsresponsible for using IBM® Cognos® Integration Server to set up extractions and towork with supported connections.

Overview

Use Cognos Integration Server to extract specialized cube data from varioussources, such as Oracle Essbase, Oracle Hyperion Planning, and Oracle HyperionFinancial Management. You can then work with this source data in a targetrelational reporting application.

IBM Cognos Integration Server includes the following features:v Automates data extraction and streamlines the process of dynamically

generating target schemas that support data warehousing and single sourcereporting.

v Extracts Oracle Hyperion cube data, metadata, and security profiles for loadinginto open-standard reporting formats or IBM Cognos TM1®.

v Performs extractions on a continuous basis to update external reporting andanalysis applications.

v Ensures that important hierarchies and drill paths that reflect the business arepreserved in the target relational reporting application.

v Provides IT departments with access to data while finance users can continue touse cube technology.

Finding information

To find product documentation on the web, including all translateddocumentation, access IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).

Accessibility features

IBM Cognos Integration Server does not currently support accessibility featuresthat help users with a physical disability, such as restricted mobility or limitedvision, to use this product.

Forward-looking statements

This documentation describes the current functionality of the product. Referencesto items that are not currently available may be included. No implication of anyfuture availability should be inferred. Any such references are not a commitment,promise, or legal obligation to deliver any material, code, or functionality. Thedevelopment, release, and timing of features or functionality remain at the solediscretion of IBM.

© Copyright IBM Corp. 2005, 2014 v

http://www.ibm.com/support/knowledgecenter

vi IBM Cognos Integration Server Version 10.2.1: Administration Guide

Chapter 1. What's new in IBM Cognos Integration Server

Knowing what features are new, changed, deprecated, or removed helps you planyour upgrade and deployment strategies and the training requirements for yourusers.

For information about new features in past releases, if available, access IBMKnowledge Center (http://www.ibm.com/support/knowledgecenter).

For an up-to-date list of environments that are supported by IBM Cognos products,including information about operating systems, patches, browsers, web servers,directory servers, database servers, and application servers, see the SupportedSoftware Environments page (http://www.ibm.com/support/docview.wss?uid=swg27039671).

New features in IBM Cognos Integration Server version 10.2.1In Cognos Integration Server version 10.2.1 there are new features.

New featuresThe IBM Cognos Integration Server has new features for 10.2.1.

You can now use a cube on a Cognos TM1 server as a source connection forCognos Integration Server to update your RDBMS or flat file star schema. You canalso use a Cognos Integration Server star schema as a source connection. For moreinformation, see “IBM Cognos Integration Server star schema connectionparameters” on page 28 and “IBM Cognos TM1 parameters” on page 27.

There are now two new selection types: Cognos TM1 and Cognos IntegrationServer star schema. For more information, see “Cognos TM1 selection options” onpage 39 and “Star schema options” on page 37.

You can now extract from Hyperion cube data (Essbase, HFM, Planning) in levelformat or generation format. For more information, see the Extract Metadata sectionin “Metadata extraction options” on page 40.

There are now more command file options. For more information, see “CommandFile Syntax” on page 60.

© Copyright IBM Corp. 2005, 2014 1



http://www.ibm.com/support/docview.wss?uid=swg27039671

http://www.ibm.com/support/docview.wss?uid=swg27039671

2 IBM Cognos Integration Server Version 10.2.1: Administration Guide

Chapter 2. Overview

Use the IBM Cognos Integration Server to automate the extraction and distributionof proprietary Oracle Hyperion business process management (BPM) data torelational data stores and other IBM Cognos Business Intelligence (BI) applications.

You can use Cognos Integration Server to extract the information from yourHyperion BPM applications into a BI warehouse or any other BI application orreporting system.

You can also use Cognos Integration Server to share data, proprietary structures,calculations, business rules, supporting detail, and security information in manyOracle Hyperion applications. Oracle Hyperion system administrators can use thegraphical user interface to create and manage complex data movements betweenapplications either manually or by using automated operations with full auditingand notification. Cognos Integration Server also facilitates single-source reporting,continuous planning, and transaction drill-through.

Cognos Integration Server scenarios

Cognos Integration Server supports the following scenarios:v Oracle Essbase data to relational database management system (RDBMS) star

schema fact tablev Oracle Essbase data to text filev Oracle Essbase metadata to star schema dimensional tables in parent-child

format, balanced generation format, balanced level format, and master datamanagement format with Essbase attributes

v Oracle Essbase metadata to text file in parent-child format, balanced generationformat, balanced level format, and master data management format with Essbaseattributes

v Oracle Essbase security to RDBMS table or text filev Oracle Hyperion Planning data to RDBMS star schema fact tablev Oracle Hyperion Planning data to text filev Oracle Hyperion financial management data to RDBMS star schema fact tablev Oracle Hyperion financial management data to text filev Oracle Hyperion financial management metadata to star schema dimensional

tables in parent-child format, balanced generation format, balanced level format,and master data management format with Essbase attributes

v Oracle Hyperion financial management metadata to text file in parent-childformat, balanced generation format, balanced level format, and master datamanagement format with Essbase attributes

Key features of Cognos Integration Server

Cognos Integration Server provides the following key features:v Cognos Integration Server extends your BPM capabilities by extracting and

transforming any level of data, metadata, and security information from OracleEssbase, Oracle Hyperion Planning, and Oracle Hyperion Financial Managementfor use in other enterprise applications or reporting systems.


v Use the automated extraction capabilities of Cognos Integration Server to enablereal-time planning, calculations, and updates to move your Oracle Hyperiondata as necessary.

v Cognos Integration Server performs multiple, parallel extractions without takingyour Oracle Hyperion applications offline.

v Oracle Hyperion structures and extraction selections can be viewed, defined, andmodified. You can save the required data transformations, mappings, andcalculations.

v Automation capabilities, such as email alerts and audit logs, help to ensure datasecurity and Sarbanes-Oxley compliance by using automated operations.

Oracle Essbase ExtractionIBM Cognos Integration Server optimizes the performance of Essbase dataextraction.

Extraction using the calculation engine

The IBM Cognos Integration Server uses the Oracle Essbase calculation enginerather than the Oracle Essbase report script engine to extract data from OracleEssbase.

Intelligent extraction

Each data block within Oracle Essbase can have a clean or dirty status. A status ofdirty indicates that a value in the block has changed since the last intelligentextraction calculation script was run against it. The Cognos Integration Server usesthe clean or dirty status of each data block within the database. When you useintelligent extraction, data blocks with a status of dirty are extracted and datablocks with a status of clean are ignored. Only data that has changed, rather thanthe entire data set specified in the selection, is exported. Intelligent extraction canimprove data extraction times because typically only a small amount of data thatmust be updated in the target connection of the selection is changed.

The Set data as clean option also resets dirty data blocks to clean after extraction.

Because intelligent extraction extracts only a subset of data , it is critical that theLoad Type option is set to Merge and that data suppression is turned off. This iscritical because data changed from a number to 0 or #Missing is still extracted tothe target connection to update the existing value. If Suppress Zeros or SuppressMissing are turned on, no records are exported and the record in the targetconnection contains the original value, leaving the target data out of sync with theEssbase database.

For more information, see “Setting up an intelligent extraction” on page 5.

For more information about suppression, see “Data extraction options” on page 40.

For more information about intelligent calculation in Oracle Essbase, see theEssbase Administrators Guide.


Custom data value filters

Use custom data value filters to limit the Essbase selection output that is based onstandard Essbase IF condition syntax. Custom data value filtering is similar to thecustom formula function in a selection, but at the selection level rather than at themember selection level.

For more information about custom data value filtering, see “Data extractionoptions” on page 40.

Attention: Custom data value filtering is only available for Type I extraction.

Custom scope control

Custom scope control filters at the selection level, and can contain many Essbasecalculation functions. This control is also used with the implicit share extractionfeature, for example using LEVELS, GENERATIONS, or UDAs to define the datato extract. For example:

@GENMBRS("Measures",3) OR @LEVMBRS("Measures",1) OR @UDA(Market, "MajorMarket")

For more information about custom scope control, see “Data extraction options” onpage 40.

Attention: Custom scope control is only available for Type I extraction.

Setting up an intelligent extractionYou can use intelligent extraction to reduce data extraction times when only asmall amount of data that needs to be updated in the target connection of theselection is changed.

Procedure1. Run an IBM Cognos Integration Server extraction with the following options:

a. On the Star Schema Options tab, select Create Star Schema (if notpreviously created). You can use any fact table format, any fact tablemember value, and any dimension table layout.

b. On the Metadata Extraction Options tab, select Extract Metadata.c. On the Data Extraction Options tab, select Extract Data, select Refresh as

the Load Type, select Suppress Zeros and Missing, and select Type I as theExtraction Type.

2. Save the selection and run the extraction.3. Create the following calc script: SET CLEARUPDATESTATUS ONLY; CALC ALL;

4. Save the calc script as Clean and run it.5. Run the Clean calc script.6. Clone the selection created in step 1 and make the following changes to the

new extraction:a. Rename the selection to include the word Intel or Intelligent (optional).b. On the Star Schema Options tab, clear Create Star Schema.c. On the Metadata Extraction Options tab, clear Extract Metadata.

Chapter 2. Overview 5

d. On the Data Extraction Options tab, change the Load Type to Merge,change Suppression to No Suppression, select Intelligent Extract, andselect Set data as clean.

7. Save this new extraction. Use the Windows Task Scheduler and a batch file toschedule the extraction to run every 2 to 10 minutes (recommended). Forexample:@ECHO *** STARTING ESSBASE EXTRACTION *** >> .\BAT_STAT.TXT

DATE /t >> .\BAT_STAT.TXT

TIME /t >> .\BAT_STAT.TXT

"C:\Program Files (x86)\\IBM\Cognos Integration Server\\ICIS\\startICISCMD.bat" 2 >>.\BAT_STAT.TXT

@ECHO *** ESSBASE EXTRACTION COMPLETE *** >> .\BAT_STAT.TXT

DATE /t >> .\BAT_STAT.TXT

TIME /t >> .\BAT_STAT.TXT

Typically, you can run the Full Extract selection run weekly and either dropand recreate the star schema, or truncate the tables and reload with the Refreshoption. Over a week, records with a null value that represent prior values or anon-value can cause the fact table to be larger than necessary.

Note: Intelligent extraction is available only for the Type I extraction type.

Oracle Essbase metadata extractionThe IBM Cognos Integration Server can extract Oracle Essbase outline metadata.

The Essbase outline is a visual representation of a cube and the related hierarchies,attributes, and calculations. There are three primary formats:v Parent-child formatv Balanced hierarchy formatv Hyperion master data management format

For more information, see Chapter 4, “IBM Cognos Integration Server star schemadefinition,” on page 69.

The parent-child format is good for ragged hierarchies. This format also providesall outline metadata attributes, such as alternative alias tables, user-definedattributes, member formulas, and calculation logic such as solve order.

The balanced hierarchy format is used to create conforming hierarchies from aragged hierarchy. You use a balanced hierarchy to re-create the same drill path thata user has inside of the multidimensional application in a relational reportingenvironment.

The Hyperion master data management (MDM) format extracts metadata in theMDM Automator format.

Oracle Essbase Security Extraction

The Cognos Integration Server can extract Essbase security-related information,such as users, groups, user-to-group associations, filters, filters-to-user associations,and filters-to-group associations.

The output of the security data can be stored in relational data tables or text files.


For more information, see “Metadata extraction options” on page 40.

Oracle Hyperion Planning data extractionThe IBM Cognos Integration Server can extract Hyperion Planning application datathat is stored in the Hyperion Planning relational database.

You can extract the following data:v supporting detailv cell notesv account annotationsv planning unit annotationsv form annotations

Oracle Hyperion Financial Management extractionThe IBM Cognos Integration Server can extract any combination of data from anyHFM application and place it into a relational fact table or into a text file.

The Cognos Integration Server generates batches of valid data intersection pointsbefore making HFM API calls. The fewer API calls that must be made, the betterthe data extraction performance. The more memory on the Cognos IntegrationServer, the larger the batches can be to reduce the number HFM API calls. You canspecify the Memory Cache option to control the amount of memory that isallocated to the Cognos Integration Server data intersection point batches. Formore information, see “Data extraction options” on page 40.

For further improvements in extraction speed, the Cognos Integration Server HFMdata extraction engine takes advantage of multi-CPU servers. Before HFMprocessing is complete, the Cognos Integration Server continues to generate a newbatch of intersection points, submits them to HFM, and so on. For moreinformation about setting the maximum number of outstanding requests to theHFM API, see “HFM extraction parameters” on page 21. The more CPUs in usewith the Integration, the more HFM requests that can be processed in parallel, andthe faster the extraction. However, the benefit of adding more requests to HFMbeyond a certain number decreases. Typically, the ExtractionThreads value is set totwice the number of CPUs on the HFM server.

HFM metadata extraction is identical to Essbase metadata extraction. For moreinformation, see “Metadata extraction options” on page 40.

Data extraction auditData extraction auditing creates a correlation between each data extraction and theselection that was used in the data extraction.

The audit table is a data table that is created in the relational target database.When data extraction auditing is enabled, a fact table audit record is added to theaudit table each time a data extraction is run.

The audit table has the same name as the fact table appended with the suffix_AUDIT. The audit table has a unique ID for each record. The ID value is alsostored in the AUDITID field of each fact table record so that each data record inthe fact table has a reference to the audit table record.

Chapter 2. Overview 7

For example, to determine the age of fact table data records, a SQL query can bebuilt linking the relationship between the fact table AUDITID and the ID field inthe audit record.

For more information about the contents of the audit table, see “Audit table” onpage 101.

Attention: Data extraction auditing can slow down a selection run. You can turnboth auditing and selection state preservation on or off. For more information, see“Setting Selection Manager options” on page 10.


Chapter 3. IBM Cognos Integration Server fundamentals

You can use the IBM Cognos Integration Server to extract multidimensional datafrom Oracle Essbase, HFM, and Planning applications into a relational databasemanagement system (RDBMS) format.

The IBM Cognos Integration Server involves the following activities:v Set the Cognos Integration Server configuration options.

For more information, see “Configuration file options” on page 18.v Use the Connection Manager to configure connections to the Hyperion

applications and to the target SQL Server databases, Oracle databases, or textfiles.For more information, see “The Connection Manager” on page 24.

v Use the Selection Manager to select the Hyperion application data to extract.For more information, see “The Selection Manager” on page 35.

v Run selections to extract data.For more information, see “Running a selection” on page 53.

All of the Cognos Integration Server activity is logged in the Integration Serverdatabase. You can view this log information in the Integration Server log viewer.You can use the log viewer to filter data based on date, log type, selection, andprocess. Information in the log viewer can be exported to a text file. For moreinformation, see “The Log Viewer” on page 53.

Integration Server Start menu items

The following menu items are available in the Windows Start menu in the IBMCognos Integration Server programs folder as part of the Cognos IntegrationServer:

Command Line UtilityStarts the Cognos Integration Server Command Line Utility.

For more information, see “The Command Line Utility” on page 55.

Database ToolYou can use the database tool to initialize a new Cognos Integration Serverdatabase or to upgrade an existing one. You can also use the database toolto switch between different databases.

For more information, see “The Integration Server Database Tool” on page12.

IBM Cognos Integration Server 10.2.1Starts the Integration Server Manager.

Starting the Integration Server ManagerYou can use the IBM Cognos Integration Server Manager to work from theIntegration Server navigation tree.


Before you begin

If you plan to extract data or metadata from Oracle Essbase or from OracleHyperion Planning, the Cognos Integration Server requires an Oracle Essbase clientto be installed on the same computer as the Cognos Integration Server. For Essbaseversion 11.1.2.x, the Essbase client is typically in the %HYPERION_HOME%\common\EssbaseRTC\11.1.2.x or %HYPERION_HOME%\common\EssbaseRTC-64\11.1.2.x folder. Ifthe Oracle Essbase client folders cannot be located, a dialog is displayed asking ifyou plan to extract data or metadata from Oracle Essbase or Oracle Planning. ClickOK and browse to the Oracle Essbase client folder location and the Oracle RDBMSlibrary folder location (for Oracle 11.1.2.0 or greater only).

If you copied the Oracle Essbase runtime client files from another computerinstead of installing Oracle Essbase client, make sure that the files are stored in afolder structure similar to the following folder structure:

\EssbaseRTC\11.1.2.0

If you copy an Essbase run time client with a version greater or equal to 11.1.2.0,you must also copy the Oracle RDBMS Library. The library is typically in the%HYPERION_HOME%\bin folder.

About this task

The Integration Server uses a built-in default SQLite database if no previousdatabase configuration is found. If a previous incompatible configuration of theIntegration Server database is detected, a dialog is displayed that prompts you toconfigure the Integration Server database. Click OK to open the Integration Serverdatabase tool and upgrade the previous database.

Use the Integration Server database tool to change the Integration Server databaseto an existing Integration Server database. For more information, see “TheIntegration Server Database Tool” on page 12.

Procedure

From the Start menu, start the Integration Server Manager or on the desktopdouble-click the IBM Cognos Integration Server icon.

Integration Server ToolsYou can use the Integration Server manager tools to set Integration Server options,configure the Integration Server database, and set up the Essbase Data Extractor.

Use the Integration Server Options to set Selection Manager Options and to settarget database table and column mappings.

Setting Selection Manager optionsYou can use the Integration Server options to specify how selections are handled.

About this task

This list describes the Selection Manager options:

Caching


v Sets the caching options to cache the Essbase or HFM outlines. Cachethe Essbase or HFM outlines to reduce the time that it takes to open aselection.

v When enabled, the outline metadata is cached on the client the first timean outline from a connection opens. Cached data is used instead ofquerying Essbase or HFM each time a selection is opened.

v Cached outlines display the date and time of the cached metadata at thetop of the outline tree.

v Ensure that changes made to the underlying outline in Essbase or HFMare propagated to the cached outlines. To update the outline cache withthe latest metadata, right-click the top of the outline node and clickRefresh Outline From Source.

Data Extraction Auditing

v Creates an audit table with the name of the fact table and the followingsuffix: _AUDIT

v The audit table is updated with a record that indicates the date and timeof the run with each data extraction run. An audit ID is added to thefact table to correspond to a record in the audit table.

v To save a binary copy of the selection and settings to the audit table,click Save Selection Instance with Audit Data.

v For more information, see “Data extraction audit” on page 7.

Bulk Copy

v Enables bulk copy for HFM and Essbase Type II and IV data extractions.Insertions into the target fact table use bulk copy instead of standardinsert statements.

v Use this option to improve performance over the standard insertstatements.

Essbase Extractor Messaging Port

v Sets the port number that is used by the Essbase Data Extractor forsending messages to the Cognos Integration Server. The Essbase DataExtractor communicates with the Integration Server by using TCP, whichrequires a specified port number.

v Use a port number of 0 (zero) or assign an available port number.v Use a port number other than 0 (zero) only if a specific port is available

for communication between the Essbase Data Extractor and IntegrationServer.

Essbase API VersionShows the version of the Essbase client that the Cognos Integration Serveris using.

Procedure1. From the Integration Server Manager window, click Tools > Integration Server

Options.2. Specify the options that you want.

Mapping target database table and column namesThe IBM Cognos Integration Server automatically uses the names of thedimensions to name the metadata tables and the columns in the fact table.

Chapter 3. IBM Cognos Integration Server fundamentals 11

About this task

You can also use Table and Column Name Mapping to modify the automaticallygenerated names.

The feature substitutes a character string that is found in the initial name withanother character string. If more than one initial value or replacement value pair isspecified for a connection type, the result of the first string substitution is used asinput to the next substitution from top to bottom of the mapping table.

You can enter Space and TAB characters as part of the initial value or replacementvalue strings as 'SPACE' or '\s' and 'TAB' or '\t', without the single quotationmarks. If the initial value string is left empty, a space character is assumed. Youcan enter space and tab characters as part of the initial value or replacement valuestrings. To enter a space character, type SPACE or \s. To enter a tab character, typeTAB or \t.

The Cognos Integration Server comes with four built-in mappings. The IntegrationServer restores the built-in mappings after a restart if they are deleted. Set thereplacement value to the initial value to disable a built-in mapping.

Attention: The character string substitution is case-sensitive.


Options.2. Click the Table and Column Name Mapping tab.3. Specify a replacement value for the initial value.

The Integration Server Database ToolYou can use the Integration Server Database Tool to initialize an Integration Serverdatabase, to upgrade the Integration Server database to a newer version, or tochange to a different database.

Initializing a Microsoft SQL Server databaseYou can use the IBM Cognos Integration Server database tool to initialize aMicrosoft SQL Server database.

Before you begin

Before you initialize a Microsoft SQL Server database, you must create an emptydatabase by using the database-specific tools.


Database Tool.2. Under Database Type, select Microsoft SQL Server 2005 or greater.3. In the Database Server text box, type the name or IP address of the SQL

Server.4. In the Database Name text box, type the name of the SQL Server database.5. Do one of the following steps:


v If Windows authentication is used to authenticate the connection to the SQLServer, select the Use SQL Server Trusted Connections check box.

v If SQL Server authentication is used, clear the Use SQL Server TrustedConnections check box and type the user name and password in the UserName and Password text boxes.Attention: To save the password with the configuration file, select the SavePassword check box. If the Save Password check box is cleared, a passwordis prompted for each time Cognos Integration Server is run.

Initializing an Oracle databaseYou can use the IBM Cognos Integration Server database tool to initialize an Oracledatabase.

Before you begin

Before you initialize an Oracle database, you must create an empty database byusing the database-specific tools.


Database Tool.2. Under Database Type, select Oracle 9.2 or greater.3. In the Database Server text box, type the name or IP address of the Oracle

server.4. In the Service Name text box, type the Oracle service name or SID.5. In the Port text box, type the port number that the Oracle service is using.6. In the User Name text box, type the Oracle login account to use.7. In the Password text box, type the password to use to connect to the Oracle

login account.Attention: To save the password with the configuration file, select the SavePassword check box. If the Save Password check box is cleared, a password isprompted for each time Integration Server is run.

Initializing an SQLite databaseYou can use the IBM Cognos Integration Server database tool to initialize anSQLite database.


Database Tool.2. Under Database Type, select SQLite.3. In the Database File text box, type the name of the file that you want to use for

the database. You can choose an existing Cognos Integration Server SQLitedatabase or type in a new name to create a new SQLite database.

4. Click Test to test the connection. You must test the connection before you canuse the database.

5. Do one of the following steps, depending on the information given in the TestIntegration Server Database Connection window:v If the database is up-to-date, click OK.v If the database is not initialized, click OK, then click Initialize in the

database tool.


v If the database is an older version, click OK, then click Upgrade in thedatabase tool.

Initializing an IBM DB2 databaseYou can use the IBM Cognos Integration Server database tool to initialize an IBMDB2® database.


Database Tool.2. Under Database Type, select IBM DB2 9.7 or greater.3. In the Database Server text box, type the IP address of the IBM DB2 server.4. In the Database Name text box, type the IBM DB2 database name.5. In the Port text box, type the port number that the IBM DB2 service is using.6. In the Schema text box, type the DB2 schema to use. If no schema is set, the

user name is set as the schema.7. In the User Name text box, type the IBM DB2 login account to use.8. In the Password text box, type the password to use to connect to the IBM DB2

login account.Attention: To save the password with the configuration file, select the SavePassword check box. If the Save Password check box is cleared, a password isprompted for each time Integration Server is run.

Installing the Essbase data extractor setup toolTo set up the Essbase data extractor, you use the data extractor setup tool to copyfiles to the Essbase server, update the Essbase server configuration files, and run aMaxL script that installs a custom-defined function (CDF) on the Essbase server.

Before you begin

To use Essbase Extraction Type I or Type III to extract data from a block storageoption (BSO) cube, you must install a CDF on the Essbase server. The CDF .jar fileand accompanying files are referred to as the Essbase data extractor. For moreinformation, see “Data extraction options” on page 40.

Procedure1. From the Integration Server Manager window, click Tools > Data Extractor

Setup Tool.2. In Essbase Server Folder, browse to or type or a valid path. For example,

C:\Hyperion\essbase, C:\Hyperion\AnalyticServices, or C:\Oracle\Middleware\EPMSystem11R1\ products\Essbase\EssbaseServer. UNC names aresupported. The Essbase server folder is the folder that contains the app, bin,and java folders of the Essbase server.

3. if the Essbase Server folder is valid and reachable from the Cognos IntegrationServer, the setup tool completes the name in Essbase Server. If you install theEssbase data extractor on an Essbase server that is not reachable, make surethat the Essbase server is the name of the Essbase server on which you areinstalling the Essbase data extractor.

4. In Administrative User and Administrator Password, type the user name andpassword of an Essbase administrative user.


5. Click Setup to start installing the Essbase data extractor. After the setup iscomplete, you are instructed on how to proceed.v Essbase server on the same server as the Cognos Integration Server - after

the setup completes, click OK, then click Register to register the CDF withEssbase.

v Essbase server installed on a different server - after the setup completes, clickOK to view instructions for completing setup of the Essbase data extractor.The last part of the setup of the Essbase data extractor is registering the CDFwith Essbase. Instructions on the registration process are in thePostExtractorSetupSteps.txt file.

v Essbase server installed on a UNIX server - when you click Setup, a messagedisplays asking if you want to use the Essbase folder, even though the folderdoes not appear to be valid. Click Yes.After the setup is complete, Click OK to view instructions for completingsetup of the Essbase data extractor.

Setting Essbase data extractor propertiesThe CIS.properties file sets the properties for the Essbase data extractor.

About this task

The CIS.properties file is installed in the same location as the Essbase dataextractor, and is required for the extractor to run properly. The properties arecommented out by default by preceding each property line with a number sign (#).

If Essbase is installed on a server that runs the Windows operating system, whenyou edit file paths, use backslashes (\) as path separators. If Essbase is installed ona server that runs the UNIX operating system, when you edit file paths, useforward slashes (/) as path separators.

Attention: Do not make any changes to the CIS.properties file unless youinstructed to do so by IBM support personnel.

Procedure1. Browse to install directory\ICIS\EssbaseExtractor.2. To edit the file, use a standard text editor. The LogFile parameter specifies the

absolute path and file name of the Essbase data extractor local log file. EssbaseData Extractor local logging is disabled by default. Remove the number sign (#)in front of the property to turn on logging of Essbase data extractor logmessages to a local log file in the following location: LogFile=C:\\Hyperion\\essbase\\java\\udf\\IntegrationServerServices.log.

Setting up the Essbase data extractor manuallyYou can set up the Essbase data extractor without using the data extractor setuptool.

About this task

These steps assume that the Integration Server is installed in the C:\ProgramFiles(x86)\IBM\Cognos Integration Server\ICIS folder.

Procedure1. Create the udf folder on the Essbase server.


a. Open the Essbase server folder on the Essbase server computer. For Essbaseversion 11.1.2.x, the server folder default is the following location:C:\Oracle\Middleware\EPMSystem11R1\products\Essbase\EssbaseServer. Donot use the C:\Oracle\Middleware\user_projects\epmsystem1\EssbaseServer\essbaseserver1 folder or similar folders.

b. Locate the java folder and open it.c. If it does not already exist, in the java folder, create a folder with the

following name in all lowercase letters: udf .2. Copy the Essbase data extractor files to the Essbase server.

a. Locate the C:\Program Files (x86)\IBM\Cognos IntegrationServer\ICIS\EssbaseExtractor folder. This is the source folder.

b. Locate the udf folder on the Essbase server. It is in the java folder in theEssbase server folder. This is the target folder.

c. Copy all files in the source folder to the target folder. Stop the Essbaseserver if the file copy fails and start it again after the file copy.

d. In the target folder, if Essbase is using a Java™ version of 1.6 or greater,rename the file db2jcc.6 to db2jcc.jar, rename the file ojdbc.6 toojdbc.jar, and rename the file sqljdbc.6 to sqljdbc.jar. If Essbase is usinga Java version of 1.5, rename the file db2jcc.5 to db2jcc.jar, rename thefile ojdbc.5 to ojdbc.jar, and rename the file sqljdbc.5 to sqljdbc.jar.Stop the Essbase server if the file rename fails and start it again after the filerename.The Java version that Essbase is using can be determined by opening theessbase.cfg file with a text editor and locating the line beginning with'JvmModuleLocation'.

Note: For UNIX based Essbase servers, use FTP to transfer the files fromthe source folder to the target folder. Make sure the FTP mode is set tobinary.

3. Change the extension of any previous Essbase data extractor jdbc JAR files.a. Locate the udf folder on the Essbase server. It is in the java folder in the

Essbase server folder.b. Change the extension of all files in the udf folder with names that start with

'SA' and with the extension of .jar. Change the extension to .deleteme.Stop the Essbase server if the file rename fails and start it again after the filerename.

4. Create the Essbase Data Extractor registration MaxL scriptRegisterEssbaseExtractor.msh.v If the Essbase server is installed on a computer that runs the Windows

operating system do the following task:– Open the RegisterEssbaseExtractor.msh file with a text file editor. The

file is in the java\udf folder in the Essbase server folder.v If the Essbase server is installed on a computer that runs the UNIX operating

system do the following task:– Open the RegisterEssbaseExtractor_UNIX.msh file with a text file editor

such as vi. The file is in the java\udf folder in the Essbase server folder– Change the [Administrator ID], [Password for your system], and

[EssbaseServer] in the login line to the Essbase server name and name andpassword for the administrative user of your Essbase server. The loginline typically looks likelogin admin password on sa-vmw-bpm


– Save the file as RegisterEssbaseExtractor.msh.5. Copy the Essbase data extractor authentication file to the Essbase server. Do

this if the Essbase server is running on a Windows operating system:a. Locate the C:\Program Files (x86)\IBM\Cognos Integration

Server\ICIS\EssbaseExtractor folder. This is the source folder.b. Locate the bin folder in the Essbase server folder. This is the target folder.c. Skip steps d) and e) if the target folder contains a file that is named

sqljdbc_auth.dll.d. If the Essbase server is running on a 32-bit computer, copy the

sqljdbc_auth.x86 file in the source folder to the target folder. If the Essbaseserver is running on a 64-bit computer, copy the sqljdbc_auth.x64 file inthe source folder to the target folder.

e. Rename the copied file to sqljdbc_auth.dll.6. Update the Java udf security policy file.

a. Open the udf.policy file with a text file editor. The file is in the java folderin the Essbase server folder.

b. Locate the line permission java.security.AllPermission;.c. If the line begins with // (two forward slashes), remove the forward slashes

and save the file.7. Update the Essbase config file

a. Open the essbase.cfg file with a text file editor. The file is in the bin folderin the user project Essbase server folder. For example, C:\Oracle\Middleware\user_projects\epmsystem1\EssbaseServer\essbaseserver1\bin.

b. Locate the line that contains the word JvmModuleLocation.c. Make sure the JvmModuleLocation path is correct, and pointing to a Jvm

version 1.5 or above.d. If the line begins with a semicolon (;), remove the semicolon and save the

file.8. Restart the Essbase server for the changes to take effect.9. Register the Essbase data extractor with the Essbase server. Make sure that the

Essbase server is running.v If the Essbase server is installed on a computer that runs the Windows

operating system do the following task:– Run the RegisterEssbaseExtractor.bat batch file on the Essbase server

computer. The file is in the java\udf folder in the Essbase server folder.v If the Essbase server is installed on a computer that runs the UNIX operating

system do the following task:– For Essbase versions 11.1.2 and up, on the Essbase server computer, run

the following command: startMaxl.shRegisterEssbaseExtractor_UNIX.msh. You can find startMaxl.sh in the binfolder in the user project Essbase server folder. For example,C:\Oracle\Middleware\user_projects\epmsystem1\EssbaseServer\essbaseserver1\bin.

– For Essbase versions older than 11.1.2, on the Essbase server computer,run the following command: essmsh RegisterEssbaseExtractor_UNIX.msh.

– For the changes to take effect, stop and start all running Essbaseapplications.


Viewing the license keyYou can see how many source connection licenses are being used.

Procedure

From the Integration Server Manager toolbar, click Help > License to view thecurrent license usage. The number of source connections used is displayed.

Configuration file optionsYou can use an ASCII text file editor to open and edit the configuration fileslocated in the IBM Cognos Integration Server install directory.

Use the following files to configure the Integration Server:

ICIS.exe.configSet options for the Integration Server Manager.

ICISCMD.exe.configSet options for the Integration Server Command Line Utility.

Ibm.Cognos.IntegrationServer.SatelliteService.exe.configSet options for the Satellite Server Service.

Attention: The configuration files should under normal circumstances not bemodified. If you modify a configuration file, you must restart the IntegrationServer Manager, Command Line Utility, or the Satellite Server, depending on thefile you modified.

Channel registration for Cognos Integration Server satelliteservers

Satellite server channel registration options must be set on both the client side andthe server side.

Client-side Channel Registration

Client-side channel registration can be set for both TCP and for HTTP. Client-sidechannel registration settings typically do not need to be modified because thesatellite server communication produces them automatically.

TCP Faster than HTTP.

Transmits binary data and cannot penetrate firewalls.

Only the port number can be modified if necessary, as follows: <channelname="ClientSideTCP" ref="tcp" port="0">

Typically, the port number is set to 0 for a client, so that data can bereturned from the satellite server to the Cognos Integration Server.

HTTP Slower than TCP.

Does not transmit binary data and can penetrate firewalls.

Only the port number can be modified if necessary, as follows: <channelname="ClientSideHTTP" ref="http" port="0">

As with TCP, the port number is typically set to 0.


Server-side Channel Registration and Remote Object Leases

The following option settings are specific toIbm.Cognos.IntegrationServer.SatelliteService.exe.config. For moreinformation about satellite server channels and leases, see the Satellite ServerInstallation Guide.

Server-Side Channel RegistrationSimilar to client-side channel registration, however, port ranges arecomputer-specific because different computers that use the sameIntegration Server database might be on different subnets. In this case, eachcomputer requires a separate set of ports. Only the port numbers aremodified in the channel settings. The port numbers that are assigned to thesatellite server must not be used by any other application on the computerand must not be blocked by a firewall.

<channel name="SASatTcp" ref="tcp" port="8009">

<channel name="SASatHttp" ref="http" port="8010">

Server-Side Remote Object LeasesCan be set in minutes or seconds.

<lifetime leaseTime="5M" sponsorTimeOut="2M" renewOnCallTime="2M"Lease ManagePollTime="10s" />

HFM custom dimensions name mappingYou can use an ASCII text file editor to open and edit the custom dimensionsname mapping options.

You can edit the following custom dimensions name mapping options:

HFM custom dimensions name mapping options<add key="HFM_UseCustomDimensionAliases" value="false" />

<add key="HFM_Custom1_Name" value="Custom1" />




Before HFM version 11.1.2.2, the four custom dimensions used thestandard names Custom1, Custom2, Custom3, and Custom4. Additionally,each custom dimension might have an alias name. To be compatible withearlier versions of the IBM Cognos Integration Server, set theHFM_UseCustomDimensionAliases option to false to override the alias names.The names set by the HFM_CustomX_Name parameters are used.

The Cognos Integration Server uses the alias names, if any are configured,if the HFM_UseCustomDimensionAliases option is set to true.

For HFM version 11.1.2.2 and greater, Cognos Integration Server alwaysuses the names that are configured in the manage metadata table orcustom dimension table for the custom dimension names.

Data value field length in star schema fact tablesYou can use an ASCII text file editor to open and edit the configuration thatdetermines data value field length in star schema fact tables.


You can edit the following fact table field length parameter:

FACTTableDataFieldLength<add key="FACTTableDataFieldLength" value="15" />

Sets the field length for data in the star schema fact table. The defaultvalue is 15.

The IBM Cognos Integration Server stores data values in relational fact tables asdecimal values. The maximum size of decimal values is determined by twoentities; the number of digits in a number and the number of digits to the right ofthe decimal point in a number. For example, the number of digits in 123.45 is 5and the number of digits to the right of the decimal point is 2.

The number of digits to the right of the decimal point is set in Data Precision onthe Data Extraction Options tab.

The number of digits in the number is the sum of the data precision value and theFACTTableDataFieldLength value.

The default value of FACTTableDataFieldLength is 15. The default for dataprecision is 2, so the maximum default value is a number such as123456789012345.67.

The values for FACTTableDataFieldLength plus data precision cannot exceed 38.

Table suffixesYou can use an ASCII text file editor to open and edit the table suffix options.

You can edit the following table suffix parameters:

Fact table suffixes options<add key="SuffixAuditTable" value="_AUDIT" />

<add key="SuffixHFMProcessManagementTable" value="_PRMGT" />

<add key="SuffixPlanningAccountAnnotationsTable" value="_PLAN_AN" />

<add key="SuffixPlanningPlanningUnitAnnotationsTable"value="_PLAN_PU" />

<add key="SuffixPlanningFormAnnotationsTable" value="_PLAN_FO" />

<add key="SuffixPlanningCellTextTable" value="_PLAN_CT" />

<add key="SuffixPlanningSupportingDetailsTable" value="_PLAN_SD" />

These options set the suffix added to the fact table name to form names ofthe audit table, the HFM process management table, the Planning accountannotations table, the Planning unit annotations table, the Planning formannotations table, the Planning cell text table, and the Planning supportingdetails table.

Essbase security filter tables suffix options<add key="SuffixEssbaseUser" value="EssbaseUser" />

<add key="SuffixEssbaseUserGroup" value="EssbaseUserGroup" />

<add key="SuffixEssbaseFilter" value="EssbaseFilter" />

<add key="SuffixExpandedFilter" value="ExpandedFilter" />

<add key="SuffixPlanningFilter" value="PlanningFilter" />


These options set the names of the Essbase user table, the Essbase usergroup table, the Essbase filter table, the Essbase Planning filter table, andthe Essbase expanded filter table.

Attention: The length of the fact table prefix, the fact table name, and each suffixcannot exceed 30 characters.

HFM extraction parametersYou can use an ASCII text file editor to open and edit the HFM extractionparameters.

You can edit the following HFM extraction parameters:

Extraction threads option<add key="ExtractionThreads" value="2" />

Sets the number of extraction threads that control the maximum number ofrequests to the HFM API that can be outstanding. The maximum value is64. Typically, you set the ExtractionThreads value to twice the number ofprocessors on the HFM server.

You can view the Extraction Threads Busy counter value in the log fileafter an extraction. The Extraction Threads Busy value counts how manytimes the Integration Server has been waiting for an extraction thread tobecome available. Increasing the number of extraction threads lowers thenumber of times the Integration Server waits for the HFM API to completea request but increase the processor usage that is associated with runningmore threads.

Output buffers option<add key="OutputBuffers" value="16" />

Sets the number of buffers available to the output thread. The outputthread writes the extracted data to the fact tables. The output threadallocates an array of the size Output Buffers x Threshold (set by the UI) forstoring output records that are extracted by the extraction threads. Theoutput thread posts a batch of records to the target connection when thethreshold is reached and continues to store output records extracted by theextraction threads.

You can view the Output Queue Full counter value in the log file after anextraction. The Output Queue Full value counts how many times theextraction threads wait for space in the output buffer to become available.A higher value decreases the blocking of the extractor threads, but canincrease processor usage.

Output indicator threshold option<add key="OutputIndicatorThreshold" value="1" />

Sets how many batches of output records to write to the target connectionbefore the number of records that are written is shown in the statuswindow. A higher value decreases the amount of network traffic betweenthe client and a satellite server during an extraction.

Password persistenceYou can use an ASCII text file editor to open and edit the password persistenceconfiguration.

You can edit the following password persistence parameter:


Password persistence option<add key="DisablePasswordPersistence" value="false" />

If set to true, the user name and password of a connection is not saved tothe configuration database. You are prompted for the user name andpassword each time a connection to the source or target is needed.

Fact table persistenceYou can use an ASCII text file editor to open and edit the fact table persistenceconfiguration.

You can edit the following fact table persistence parameter:

Fact table persistence option<add key="FactTableDropDisabled" value="false" />

If set to true, the fact table and the temporary fact table are not droppedand created if they exist. If set to true, the temporary fact table is notdropped after a selection is run.

Audit table persistenceYou can use an ASCII text file editor to open and edit the audit table persistenceconfiguration.

You can edit the following audit table persistence parameter:

Audit table persistence option<add key="AuditTableDropDisabled" value="true" />

If set to true, the audit table is not dropped and created if it exists

Fact table and column name quotation marksYou can use an ASCII text file editor to open and edit the configuration thatdetermines whether to names are enclosed in quotation marks.

You can edit the following name quotation marks parameters:

QuoteTableNames<add key="QuoteTableNames" value="true" />

If set to true, relational target table names are enclosed in quotation marks.

If set to false, only table names that are reserved or invalid names for thatparticular target database are enclosed in quotation marks.

QuoteColumnNames<add key="QuoteColumnNames" value="true" />

If set to true, the columns of the following tables are enclosed in quotationmarks: fact tables, HFM dimension tables, HFM process managementtables, Planning units tables, Planning account annotation tables, Planningcell text tables, Planning form annotations tables, and Planning supportingdetails tables.

If set to false, only column names that are reserved or invalid names forthat particular target database are enclosed in quotation marks.


Validate member selections before you run the command-lineutility

You can use an ASCII text file editor to open and edit the configuration thatdetermines whether to validate member selections before the command-line utilityis run.

You can edit the following member selection validation parameter:

SISCMDValidateMemberSelections<add key="SISCMDValidateMemberSelections" value="true"/>

If set to true, the command-line utility checks the members of a selectionagainst the actual database outline before the selection is run. If one ormore members are deleted from the outline, the run fails. The missingmembers are displayed in the command-line window and logged to thelog file.

Attention: Setting this option to false might speed up running a selection. Do soonly if you know that your Essbase outline is unchanged.

Use Unicode RDBMS table formatYou can use an ASCII text file editor to open and edit the configuration that forcesthe IBM Cognos Integration Server to use the Unicode format.

You can edit the following Unicode format parameters:

AlwaysUseUnicodeRDBMSTableFormatEssbase<add key="AlwaysUseUnicodeRDBMSTableFormatEssbase" value="false" />

Set the value to true to force the IBM Cognos Integration Server to use theUnicode format of the Essbase dimension and fact tables, regardless of thecharacter encoding of the Essbase application.

AlwaysUseUnicodeRDBMSTableFormatHFM<add key="AlwaysUseUnicodeRDBMSTableFormatHFM" value="true" />

Set the value to true to force the IBM Cognos Integration Server to use theUnicode format of the HFM dimension and fact tables.

Maximum number of LINK argumentsYou can use an ASCII text file editor to open and edit the maximum number oflink arguments configuration.

You can edit the following maximum number of link arguments parameter:

MaxLinkArguments<add key="MaxLinkArguments" value="100" />

Sets the maximum number of arguments in a LINK statement.

You might receive the following message:Syntax error in LINK Command. Number of arguments exceeded themaximum of [50]If you receive the error when you run a Type IV Essbase data extraction,set the value to 50.


Large data valuesYou can use an ASCII text file editor to open and edit the large data valuesconfiguration.

You can edit the following large data values parameter:

AcceptVeryLargeDataValues<add key="AcceptVeryLargeDataValues" value="false" />

Enables the handling of Essbase data values greater than 7.9 x 10^28.

By default, when you use Essbase Type IV and Type II data extractionmethods data values cannot exceed 7.9 x 10^28 when you extract to anRDBMS target. To enable the extraction of larger data values, set the optionto true, or extract to a flat file target.

Attention: Rounding errors can occur when this option is enabled and youextract to an RDBMS target.

The Connection ManagerYou can use the Connection Manager to create, edit, test, and delete connections.

Connections are paths between data sources from which data is extracted andtargets in which extracted data is stored.

Connections to the following data sources are supported:v Cognos TM1v Cognos Integration Server star schemav Oracle Essbasev Hyperion Planningv Hyperion Financial Management

Connections to the following data targets are supported:v Cognos TM1v Microsoft SQL Server using a trusted connectionv Microsoft SQL Server using SQL Server loginv IBM DB2v Oraclev Text files

Creating a connectionConnections are paths between data sources from which data is extracted andtargets in which extracted data is stored. Each connection has its own uniqueconnection ID.

Procedure1. Click Connection Manager in the IBM Cognos Integration Server navigation

tree.2. From the toolbar, click New Source Connection or New Target Connection.3. In the connection editor, select a connection type from the Connection Type

menu. You can change the default connection details for your specificconnection, such as Name and Description, to make them more meaningful.


Appropriate parameters for the type of connection are displayed.4. To edit the connection parameter values, under Parameter Value click the

parameter. The password parameter field is masked for security purposes.5. If a satellite server is used, select Enabled for Satellite Server. For more

information, see “Enabling a Connection to use a satellite server.”6. Click Test to test the connection.

For all connections except SQL Server using trusted connections and text fileconnections, if you leave the user name or password blank, you are promptedfor a user name and password when the Cognos Integration Server uses theconnection.

7. Click Save or Save and Close to keep your settings. Click Close to close thewindow without saving your connection.

Enabling a Connection to use a satellite serverYou can enable HFM connections to use a satellite server.

About this task

The default port numbers for a satellite server is 8009 for TCP protocol and 8010for HTTP protocol. Check with the administrator that installed the satellite serverto confirm the port numbers, if necessary.


tree.2. In the Connection List window, select an HFM connection.3. Click Edit.4. Select Enabled for Satellite Server.5. Enter the Server and PortNumber.6. Select the Protocol.

The protocol can be either TCP or HTTP. For more information, see “Channelregistration for Cognos Integration Server satellite servers” on page 18.

Testing a connectionYou can test a connection to ensure that it is functioning properly.


tree.2. In the Connection List window, select a connection.3. Click Test.4. Click OK to confirm that the test was successful. If the connection cannot be

made, check the log file for further details.

Tip: With a connection selected, click Edit, then click Test to view the resultsunder the Connection Parameters window.

Editing a connectionYou can edit a connection to specify the connection parameters.


About this task

For more information, see “Connection parameters” on page 27.


tree.2. In the Connection List window, select a connection.3. Click Edit.

Deleting a connectionYou can delete a connection that is no longer needed.

Before you begin

If a connection is used by a selection, it cannot be deleted. To delete a connectionthat is no longer needed, first delete the selection and then delete the connection.For information about viewing a list of selections that use the connection, see“Viewing connection uses” on page 27.


tree.2. In the Connection List window, select a connection.3. Click Delete.

Tip: To delete multiple connections, press Ctrl and click each connection, orpress Shift and click to select a range of connections.

Cloning a connectionYou can use cloning to create a new connection in a single step.


tree.2. In the Connection List window, select a connection.3. Click Clone. The cloned connection appears as the last entry in the Connection

List window.

Exporting a connectionYou can export a connection to a different location.

About this task

Connections are exported to files with a .sac extension. Passwords within theexported file are encrypted.


tree.2. In the Connection List window, select a connection.


3. Click Export.4. Enter a file name to export the connection to.5. Click Save.

Importing a ConnectionYou can import a connection from a different location.


tree.2. In the Connection List window, select a connection.3. Click Import.4. Select a previously exported connection and then click Open.5. Click OK to confirm that the exported connection was successfully exported.

Viewing connection usesYou can identify where and how a connection is being used.

About this task

For example, you can use this procedure to view the selection ID of a specificconnection, and that it is being used as a source connection.


tree.2. In the Connection List window, select a connection.3. Click Uses.4. Either right-click the connection and then select View Uses or from the menu,

click Connection Manager > View Uses .

Connection parametersYou can specify the connection parameters for the connections that you create.

IBM Cognos TM1 parametersYou can specify the Cognos TM1 connection parameters.

The following observations apply only to TM1 target connections; they are notapplicable to source connections.v When selecting a TM1 target connection in an open selection, the Star Schema

Options tab transforms into the Cube Options tab, and the star schema optionsnow become cube-specific options.

v Only leaf (level 0) members can be selected for a TM1 target. Dimensions thatare chosen for export but do not have any explicit member selections areexpanded to leaf members only. If the Member Selections grid contains non-leafmember selections when the selection is run, then either the non-leaf memberselections are eliminated, or the extraction is cancelled.

v Security data, such as Essbase filters, or other type of non-fact data, such asHFM Journal entries and Planning account annotations, cannot be exported.


The following list describes the Cognos TM1 connection parameters for both sourceconnections and target connections. For the target connection, there is no Cubeparameter.

Admin ServerThe name of the TM1 administration server.

Admin Server PortThe port of the TM1 administration server. The default port is 5895 fornon-SSL connections and 5898 for SSL connections.

Admin Server uses SSLType YES to connect to the TM1 Admin Server using SSL, otherwise typeNO.

Server The name of the TM1 data server.

Cube The name of the TM1 cube (TM1 source connections only).

User NameThe TM1 data server user name.

PasswordThe TM1 data server password.

IBM Cognos Integration Server star schema connectionparametersYou can specify the Cognos Integration Server star schema connection parameters.

Attention:

v IBM Cognos Integration Server source star schemas must be in parent-childformat. The star schemas must be complete, that is, they must have a fact tableand all metadata tables that correspond to the fact table dimension columns andthe wide dimension, if one exists.

v Cognos Integration Server supports star schemas from all possible extractiontypes: Essbase, Planning, HFM, TM1, and Cognos Integration Server starschema.

v Exported security data, such as Essbase filters, or other types of data that are notfact data, for example, HFM Journal items and Planning annotations, cannot beimported and are disregarded.

v The source fact table can be in narrow or wide format, and can contain membernames, member IDs, aliases, or custom names.

v The source star schemas can have column mappings, except for wide members,where a wide source fact table exists.

The following list describes the connection parameters that are unique to CognosIntegration Server star schema:

Prefix The prefix of the CIS star schema.

Fact TableThe CIS star schema fact table name (without star schema prefix).

Spin Dimension Table(Optional) The wide format spin dimension table name (without starschema prefix). This parameter should be defined only if the source facttable is in wide format.

In addition to these parameters, Cognos Integration Server star schema supportsRDBMS connections of various types. For more information, see “SQL Server


trusted connection parameters” on page 31, “SQL Server login connectionparameters” on page 32, “Oracle connection parameters” on page 32, and “IBMDB2 connection parameters” on page 33.

Essbase connection parametersYou can specify the Essbase connection parameters.

The following list describes the Essbase connection parameters:

Essbase ServerThe name of the Essbase server.

ApplicationThe Essbase application on the Essbase server.

DatabaseThe Essbase database that belongs to the Essbase application.

OutlineThe Essbase outline from the Essbase database. Typically the same name asthe Essbase Database parameter.

User NameThe user name for logging in to Essbase. Typically a user with Admin orSupervisor privileges.

PasswordPassword of the user that is specified in the User Name parameter.

Planning connection parametersYou can specify the Planning connection parameters.

A Planning connection consists of two parts. The first part connects to the Essbasedatabase in the same way as a regular Essbase connection. The second partconnects to the relational database management system (RDBMS) where thePlanning data is stored.

Attention: In the New Oracle Hyperion Planning Connection window, inRDBMS Connection Type, select the RDBMS connection type before you configurea Planning connection.

Essbase Planning connection parameters

The following list describes the Essbase connection parameters that are the firstpart of the Planning connection configuration:

Essbase ServerThe name of the Essbase server.

ApplicationThe Essbase application on the Essbase server.

Essabase DatabaseThe Essbase database that belongs to the Essbase application.

OutlineThe Essbase outline from the Essbase database. Typically the same name asthe Essbase Database parameter.

Essbase User NameThe user name for logging in to Essbase. Typically a user with Admin orSupervisor privileges.


Essbase PasswordPassword of the user that is specified in the User Name parameter.

RDBMS connection parameters for SQL Server with a login connection

The following list describes the RDBMS connection parameters for SQL Server witha login connection:

SQL ServerThe name of the SQL Server.

To connect to a non-default instance, add a back slash (\) and the instancename to the server name. For example, MyServer\INST1.

DatabaseThe name of the database that is used as the target for data and metadata.

Login NameThe SQL Server user name that is used to log in to the specified database.

The user typically needs privileges to create tables, query data, and loaddata.

PasswordThe password for the Oracle Login Name parameter.

Passwords that contain an exclamation mark (!) cannot be used for OracleEssbase data extractions.

Port The port number that is used by the SQL Server instance.

The default port is 1433.

Leave the Port parameter blank to connect to a dynamic port.

Connection TimeoutThe Integration Server cancels a connection request to the SQL Server if aconnection cannot be made within this amount of time, in seconds.

For an unlimited wait time, set the timeout value to 0 (zero).

Command TimeoutLength of time, in seconds, that a query can run on the SQL Server beforeit times out.


RDBMS connection parameters for SQL Server with a trustedconnection

The RDBMS connection parameters for SQL Server trusted connections areidentical to the SQL Server login connections, with the exception that there is noLogin Name parameter to specify.

RDBMS connection parameters for an Oracle connection

The following list describes the RDBMS connection parameters for an Oracleconnection:

Oracle ServerThe name of the server where the Oracle target database is located. Youcan also use a TNS name, if used.


SID The Oracle SID on the Oracle server. Leave the Service Name parameterblank to use the SID parameter.

Service NameThe Oracle service name on the Oracle server. Leave the SID parameterblank to use the Service Name parameter.

Port The application port number that is used by the Oracle instance on thespecified host.


User NameThe Oracle user name. The user typically has privileges to create tables, toquery data, and to load data.

PasswordThe password for the Oracle User Name parameter.

Passwords that contain an exclamation point (!) cannot be used for OracleEssbase data extractions.

HFM connection parametersYou can specify the Oracle Hyperion Financial Management (HFM) connectionparameters.

The following list describes the HFM connection parameters:

HFM ClusterThe name of the Hyperion HFM server cluster. The cluster can be local tothe IBM Cognos Integration Server or on remote computers.

If the HFM cluster is remote, a Satellite Server must be installed on theHFM server and the connection must be set up to connect by using theSatellite Server.

HFM DomainThe HFM domain that is set up by your HFM administrator.

HFM ApplicationThe HFM application that is used to extract metadata or data from theHFM server and domain specified.

HFM AdminUserThe HFM user with privileges over the selected HFM application that isused to extract data and metadata.

HFM PasswordPassword for the user that is specified in the HFM AdminUser parameter.

Attention: HFM connections might use either a local server or a Satellite Server.For Microsoft Windows 2003/2008 x64 Standard Edition operating systems, onlysatellite server connections are available. In that case, a satellite server must beinstalled on the local Cognos Integration Server computer. For more information,see “Satellite server connection parameters” on page 34.

SQL Server trusted connection parametersYou can specify the SQL Server trusted connection parameters.

The parameters for SQL Server trusted connections are identical to the SQL Serverlogin connections, with the exception that there is no Login Name parameter tospecify.


For more information, see “SQL Server login connection parameters.”

SQL Server login connection parametersYou can specify the SQL Server login connection parameters.

The following list describes the SQL Server login connection parameters:

SQL ServerThe name of the SQL Server.

To connect to a non-default instance, add a back slash (\) and the instancename to the server name. For example, MyServer\INST1

DatabaseThe name of the database that is used as the target for data and metadata.

Login NameThe SQL Server user name that is used to log in to the specified database.

The user typically needs privileges to create tables, query data, and loaddata.

PasswordThe password for the Oracle Login Name parameter.


Port The port number that is used by the SQL Server instance.


Leave the Port parameter blank to connect to a dynamic port.

Connection TimeoutThe IBM Cognos Integration Server cancels a connection request to theSQL Server if a connection cannot be made within this amount of time, inseconds.


Command TimeoutLength of time, in seconds, that a query can run on the SQL Server beforeit times out.


Oracle connection parametersYou can specify the Oracle connection parameters.

The following list describes the Oracle connection parameters:

Oracle ServerThe name of the server where the Oracle target database is located. Youcan also use a TNS name, if used.

SID The Oracle System ID (SID) on the Oracle server. The SID uniquelyidentifies a particular database on a system. Leave the Service Nameparameter blank to use the SID parameter.

Service NameThe Oracle service name on the Oracle server. Leave the SID parameterblank to use the Service Name parameter.


Port The application port number that is used by the Oracle instance on thespecified host.


User NameThe Oracle user name. The user typically has privileges to create tables, toquery data, and to load data.

PasswordThe password for the Oracle User Name parameter.


Connection TimeoutThe Oracle server cancels a connection request if a connection cannot bemade within this amount of time, in seconds.

For an unlimited wait time, set the timeout value to 0.

Command TimeoutThe Oracle server cancels a query if not completed within this amount oftime, in seconds.


IBM DB2 connection parametersYou can specify the DB2 connection parameters.

The following list describes the DB2 connection parameters:

DB2 ServerThe DB2 server name.

DB2 DatabaseThe DB2 database name.

DB2 SchemaThe DB2 schema name. If this field is left blank, the User ID parameter isused as the schema name.

Port The DB2 server port number used.

User IDThe user login ID.

PasswordThe password for the user ID.

Connection TimeoutDB2 Server cancels a connection request if a connection cannot be madewithin this amount of time, in seconds.

Command TimeoutDB2 Server cancels a query if not completed within this amount of time, inseconds.

System Catalog NameThe name of the DB2 system catalog. Use the name SYSCAT.TABLES forMicrosoft Windows and AIX® DB2 databases. Use the nameSYSIBM.SYSTABLES on MVS™.


Text file connection parametersYou can specify the text file connection parameters.

The following list describes the text file connection parameters:

Data File NameThe name of the data output file, also known as the fact data file.

If Essbase is running in a Microsoft Windows environment, the pathparameter is added to the file name if the name does not have a fullyqualified path included.

If Essbase is running in a UNIX environment, the data file name must beprefixed by an absolute path.

Path The path where data and metadata output is placed.

For Essbase Type I and III data extractions, the output path is seen fromthe server where Essbase is running and the path must exist.

For Essbase Type II and IV data extractions, the output path is seen fromthe server where the Integration Server is running.

For metadata extractions, the path is always seen from the server wherethe Integration Server is installed. UNC paths are supported.

The path is not used for data extractions if Essbase is running in a UNIXenvironment.

Column DelimiterThe column delimiter to be used in the data and metadata files.

To insert a tab character, type TAB or \t.

To insert a space character, type SPACE or \s.

Column HeadersTo include column headers in the fact tables, type YES. To leave columnheaders out of the fact tables, type NO.

ID ColumnTo include an ID column in the fact tables, type YES. To leave an IDcolumn out of the fact tables, type NO.

Metadata Column HeadersTo include column headers in the metadata tables, type YES. To leavecolumn headers out of the metadata tables, type NO.

Metadata ID ColumnTo include an ID column in the metadata tables, type YES. To leave an IDcolumn out of the metadata tables, type NO.

Character EncodingFact and metadata text files character encoding. The values are ASCII,Unicode, BIGENDIANUNICODE, and UTF8.

Satellite server connection parametersYou can specify the satellite server connection parameters.

For more information, see “Enabling a Connection to use a satellite server” onpage 25.

The following list describes the satellite server connection parameters:


Server Satellite Server name.

Port NumberThe default port numbers for a Satellite Server are 8009 for TCP and 8010for HTTP.

ProtocolTCP or HTTP.

The Selection ManagerUse the Selection Manager to specify the source and the target connections to beused in an extraction, the type of metadata or data to be extracted, and otherextraction parameters.

To open the Selection Manager, click Selection Manager in the IBM CognosIntegration Server navigation tree.

Three selection types are supported:v Essbase selectionsv Planning selectionsv Hyperion Financial Management (HFM) selections

Creating a selectionYou can create a selection to specify which data to import.

Before you begin

Before you create a new selection, you must create the source and the targetconnections to be used by the selection. For more information, see “TheConnection Manager” on page 24.

Procedure1. To open the Selection Manager, click Selection Manager in the IBM Cognos

Integration Server navigation tree.2. From the New Selection menu, click New Essbase Selection, New Planning

Selection, New HFM Selection, New TM1 Selection, or New Star SchemaSelection.

3. In Selection Name, type a meaningful name. You can also provide adescription.

4. From Source Connection, select an existing connection to use as a source.5. From Target Connection, select an existing connection to use as a target.6. Specify the extraction options and selection configuration.

Opening a selectionYou can open a selection to edit its configuration.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Open.


Deleting a selectionYou can delete a selection that is no longer needed.

About this task

To preserver data integrity, the selection metadata in the IBM Cognos IntegrationServer database is not physically deleted. The selection record is flagged as deletedand can no longer be used by the Cognos Integration Server. However, themetadata of the selection can still be referenced for auditing purposes.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Delete.

Cloning a selectionYou can use cloning to create a new selection in a single step.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Clone.4. Click Yes to clone the selection.5. Click OK to confirm the successful cloning. A new selection opens. If more

than one selection is cloned, the last cloned selection opens.

Importing a selectionYou can import a previously exported selection.

About this task

To import a previously exported selection, the source and target connections forthe selection to be imported must exist. For more information, see see “TheConnection Manager” on page 24.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Import.4. In the Import Selection window, browse to the location of the selection file.

Selection files have the extension .sas.5. Specify the existing source and target connections. Ensure that the correct type

of source connection is specified (Essbase, Planning, or HFM) for the selectionto be imported.

6. Click OK to import.

Exporting a selectionYou can export a selection.


About this task

Selections are exported to files that have the extension .sas. Any passwords withinthe exported file are encrypted.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Export.4. In the Export Selection window, specify the export location and file name. You

can export the related source and target connections as well.5. Click OK to export.

Setting extraction optionsYou can set the extraction options of a selection.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Open.4. Click the appropriate option tabs and specify the wanted settings.

Selection information optionsThe selection information specifies the name, description, and connections that areused by the selection.

The following list describes the selection information options for Essbase, Planning,and HFM selections:

Selection NameThe name that is used to identify the selection.

DescriptionOptional description and notes.

Source ConnectionThe source connection that is used by the selection. You select a connectionfrom the list of previously configured connections. The outline of theEssbase, Planning, or HFM application is automatically retrieved anddisplayed after a source connection is selected.

Target ConnectionThe target connection that is used by the selection.

Star schema optionsYou can specify the extraction options for a star schema.

You can use a star schema to convert a fact table from a previous extraction into adifferent format: narrow or wide, member names or member IDs, and so on. Youcan also use a star schema to filter the fact table data or export data to a differenttarget, without having to extract the same data from an OLAP source again.


Attention:

v For extraction from a Cognos Integration Server star schema that uses a DB2RDBMS source, you must create a USER TEMPORARY tablespace on the chosenDB2 source database for the extraction to run successfully.

v You can extract from a Cognos Integration Server star schema only inparent-child format: source column mappings and custom names are propagatedto the target, unless overwritten by the user.

v Cognos Integration Server star schema supports export to targets with membernames or member IDs, column mappings, aliases, and custom names.

v Cognos Integration Server star schema supports all types of targets: relational,text file, or Cognos TM1.

The following list describes the star schema extraction options for Essbase,Planning, HFM, Cognos Integration Server star schema, and Cognos TM1selections:

Create Star SchemaThis option is only available for RDBMS target connections. If selected, theIBM Cognos Integration Server creates the dimension (metadata) tables andthe fact table before metadata and data is extracted. If the tables exist, theyare dropped and re-created. The dimension tables are re-created only ifmetadata extraction is selected. The fact table is re-created only if dataextraction is selected.

FACT Table NameThe name of the fact table where data is extracted to. The name is prefixedwith the star schema prefix.

Star Schema PrefixA prefix that is given to all of the star schema tables that are created withthis selection so that multiple star schemas can be extracted to the samedatabase. A typical naming convention is a short prefix followed by anunderscore, for example ABC_.

FACT Table FormatThis option determines the layout of the fact table.v If the Narrow format is selected, the fact table columns consist of one

column for each dimension plus one column for data and one columnfor the audit ID.

v If the Wide format is selected, the fact table consists of one column foreach dimension except for the wide dimension, columns for each widedimension member that is selected as part of the member selection, anda column for the audit ID.

For HFM selections, the wide dimension is always the period dimension.

For Essbase and Planning selections, the wide dimension is the spindimension. For more information about spin dimensions, see “Essbasecolumn selections” on page 48.

Attention: With wide format, it is possible to select a dimension columnand a data column with the same name, even though this might result inan error. For example, selecting the Year dimension in an HFM selectionand the [Year] member of the Period dimension results in an error. Thishas the following solutions:v Use narrow format.v Do not select the Year column in the fact table.


v Do not select the [Year] member of the period dimension.v Extract data to a text file.

An example of the wide format: if the member selection for an HFMselection consists of Jan and Feb, the fact table consists of data columns of"Jan" and "Feb".

The wide format can reduce the number of records that are stored in thetarget connection that is determined by the number of wide dimensionmembers selected. For example, if Jan through Dec is selected as the widedimension, the wide format produces one record for every 12 under thenarrow format.

For more information, see “Essbase and HFM narrow fact table” on page94 and “Essbase and HFM wide fact table” on page 95.

FACT Table Member ValuesThis option determines the format of the dimension column values of thefact table.

If set to Use Member Names, the values are the names of the members.The dimension column values in the fact table are text strings, which takeup more hard disk space and are slower to query when joined with thedimension tables.

If set to Use Member ID Reference, the values use an ID that referencesthe ID of the member in the related dimension table. The IDs are integers,which take up less space and have faster query times than text strings.

Use Member ID Reference is not valid when you use a text file target.

Dimension Table LayoutThis option determines the format of the metadata tables.v Parent-child

v Balanced Hierarchy I: you can use the translation table to specify aname for each dimension's generation or level. These names are used asthe respective dimension table's column names for each generation orlevel.

v Balanced Hierarchy II: QlikView layout.v Master Data Management

v MDM Version: Master Data Manager version number for MDMmetadata exports

For more information, see “Parent-child format” on page 70, “Generationformat” on page 71, “Level format” on page 72, and “Master datamanagement format” on page 74.

Max. UDAsApplies only to Essbase and Planning.

Sets the maximum number of UDA columns in the Essbase dimensiontables. For more information, see “Essbase dimension table” on page 74

Cognos TM1 selection optionsYou can use Cognos TM1 as a selection.

The selection options for TM1 are similar to the selection options for Essbase,Planning, and HFM selections. For more information, see “Selection informationoptions” on page 37.


Attention: TM1 selections only support export to parent-child, narrow formattargets with member names - aliases or custom names are not supported.

Metadata extraction optionsYou can specify the metadata extraction options.

The following list describes the metadata extraction options for Essbase, Planning,and HFM selections:

Extract MetadataApplies to Essbase, Planning, and HFM selections.

Select this option to extract metadata to the respective dimension tables.For Essbase and Planning, metadata is extracted only for the dimensionsthat are selected in the Essbase column selections.

Under Balanced Hierarchy I, you can select either Generation Format, inwhich metadata columns are ordered from the top down, or Level Format,in which metadata columns are ordered from the bottom up. The systemfinds the maximum level of the drill path and then adds the requirednumber of columns to support holding all of the levels. Where there arenull values, for example where a level does not exist for any given drillpath, the cells are filled in with the highest level for that drill path.

Extract UsersApplies to only Essbase and Planning selections.

Select this option to extract Essbase users data and generate theEssbaseUser table.For more information, see “Essbase users tables” on page 104.

Extract User GroupsSelect this option to extract Essbase user groups data and generate theEssbaseUserGroup table.

For more information, see “Essbase users tables” on page 104.

Extract FiltersSelect this option to extract Essbase filters data and generate theEssbaseFilter table.

For more information, see “Essbase filters tables” on page 102.

Extract Expanded FiltersSelect this option to extract Essbase expanded filters data and generate theExpandedFilter table.

For more information, see “Essbase filters tables” on page 102.

Extract Planning FiltersApplies to only Essbase and Planning selections.

Select this option to extract Planning filters data and generate thePlanningFilter table.For more information, see “Essbase filters tables” on page 102.

Data extraction optionsYou can specify how data is extracted in a selection.

The following list describes the data extraction options for Essbase, Planning, andHFM selections:


Extract MetadataApplies to Essbase, Planning, and HFM. Extracts Essbase or HFM data tothe fact table.

Data PrecisionApplies to Essbase, Planning, and HFM. Specifies the number of decimalplaces the extracted data is rounded to.

Record CommitApplies to Essbase, Planning, and HFM. Specifies the number of extracteddata records that are held in memory before they are committed to thetarget connection.

For example, if the target connection is SQL Server and the record commitlevel is 1000, records are written to the SQL Server in blocks of 1000.

Attention: This option helps data extraction performance. A higherrecord commit number can boost the performance by lowering the numberof database accesses. However, a high record commit requires morememory for intermediate storage on the server where the IBM CognosIntegration Server is located.

Load TypeApplies to Essbase, Planning, and HFM. Specifies how data is written tothe target connection:v Merge: The extracted data records are merged with existing records.

This option is not supported for text file target connections.v Refresh: All data records in the target connection are deleted and

replaced with the data records from the selection data.v Append: Data records from the selection are appended to the target data

source. Existing data is not affected.

Include Cell Status in FACT TableApplies to HFM. Includes cell status in the fact table.

Attention: Selecting this option lengthens the data extraction time.

SuppressionApplies to Essbase, Planning, and HFM. Specifies options for suppressingintersection points:v Suppress Zeros (Essbase and Planning selections only): Intersection

points with data values of zero (after rounding up to the specified dataprecision) are not extracted.

v Suppress Missing: All intersection points that are #Missing or NULL arenot extracted.

v Suppress Shared Entity Members (HFM selections only): Suppresses theextraction of duplicate Entity Member data intersection points fromHFM where the Entity name and Parent name are the same. The sameEntity name with two different parents is still extracted. This option isonly enabled if Extract Entity Parent members to FACT table isselected.

v Suppress Dynamic Accounts Members (HFM selections only): Nointersection point where the Accounts member is dynamic is extracted.Selecting this option can improve the extraction performance.

v Suppress Relative Parent Entity Members (HFM selections only):Suppresses the extraction of data from intersection points from HFMwhere the Entity member's parent is not the default entity parent.


Intelligent ExtractApplies to Essbase and Planning. Specifies that only data that is changedsince the last extraction is extracted.

Selecting this option makes Essbase examine the Clean or Dirty flags onEssbase blocks and extract only the data from Dirty blocks.

Only available for Essbase extraction type I.

Selecting Set data as clean will set the data blocks to Clean after theextraction. Available for Essbase extraction types I and III.

For more information, see “Oracle Essbase Extraction” on page 4.

Extract Stored Members OnlyApplies to Essbase and Planning. Specifies that dynamic members are leftout of the extraction.

Available for Essbase extraction types I and III.

Use Sparse DiscoveryApplies to Essbase and Planning. Enables the Essbase sparse discovery.Sparse discovery can reduce the extraction time for sparsely populateddatabases. Sparse discovery reduces extractions of intersections withmissing data and is therefore not available if Suppression is set to notsuppress missing data.

Note: The selected part of the Essbase outline must be aggregated beforeyou run a data extraction with Use Sparse Discovery enabled.

Note: If member formulas refer to attribute dimensions, the results of thedata extraction that uses sparse discovery might be unexpected.

Available for Essbase extraction types II and IV.

Level 0 OptimizationApplies to Essbase and Planning. Optimizes the Sparse Discovery forselections with member functions 'Select Members from here based onLevel' and level = 0 (zero).

Available when Use Sparse Discovery is enabled.

Set Data as CleanApplies to Essbase and Planning. Specifies that the status of the Essbasedata blocks are set to Clean after the extraction.

Available for Essbase extraction types I and III.

Use AliasApplies to Essbase and Planning. Specifies that member aliases areextracted to the target connection fact table rather than the member names.This option has no effect if the FACT Table Member Values option is setto Use Member ID Reference.

If you use extraction type III and a text file target, the exported dimensionvalues will be member names.

Implicit Share OverrideApplies to Essbase and Planning. Settings:v OFF

v PARENT-CHILD

v UDA


v GENMBRS

v LEVMBRS

Essbase implicitly removes parent members that have only a single childmember. In the following outline, data that is extracted from products 500,500-10, 500-10-10 show up in the output as if coming from 500-10-10-10.The background text is deliberately blurred.

To correct this situation, set the Implicit Share Override option toPARENT-CHILD.

This option applies only to Essbase extraction type I.

Extract Process Management DataApplies to HFM. Specifies that process management data is extracted frommembers that are selected in the Member Selections window.

Extract Journal EntriesApplies to HFM. Specifies that journal entries are extracted from membersthat are selected in the Member Selections window, or all journal entriesfor the HFM application are extracted.

Extract Cell Line Item DetailsApplies to HFM. Specifies that cell line item details are extracted frommembers that are selected in the Member Selections window, or all cell lineitem details for the HFM application are extracted.

Extract Cell TextApplies to HFM. Specifies that cell text is extracted from members that areselected in the Member Selections window or all Cell Text for the HFMapplication is extracted.

Extract Cell HistoryApplies to HFM. Specifies that cell history is extracted from members thatare selected in the Member Selections window or all cell history for theHFM application.

Memory CacheApplies to HFM. Contains a valid value 1 - 200 kilobytes and is used tocontrol the amount of memory that is used by the HFM data extractorwhen batching data intersection requests before they are submitted to theHFM API. The higher the setting, the more data intersection points can bebatched within the Cognos Integration Server before calling HFM for thedata points. This can improve performance with HFM data extractions.

Figure 1. Example of a situation that requires implicit share override


For more information, see “Oracle Hyperion Financial Managementextraction” on page 7.

Custom Data Value FilterLimits the Essbase selection output that is based on standard Essbase IFcondition syntax. Custom data value filtering is similar to the MemberSelection Custom Calculation function, but at the selection level rather thanat the member selection level.

For example, you type the following values to filter out data less than1000:

[[DataValue]]<1000

To return data between 200 and 1000, you type:

[[DataValue]]>200AND[[DataValue]]<1000

Only available for Essbase extraction type I.

Custom Scope ControlApplies to Essbase and Planning. Provides an alternative way of enteringmember selection criteria in addition to the function provided by theSelection Manager.

For example, to select all members of a Market dimension that are taggedwith the User Defined Attribute (UDA) of Major Market, add @UDA(Market,"Major Market") to the control.

The control is also used with the Implicit Share Override feature. Formore information, see the Implicit Share Override option.

Not available for Essbase extraction type II and type IV.

Extraction typeApplies to Essbase and Planning. Select this option to specify the extractiontype. For more information, see “Essbase extraction types” on page 50.v Type I: This extraction type offers the highest flexibility and feature set.v Type II: An alternative extraction type that in some cases yields higher

performance.v Type III: A high-speed extraction type. This option is only available

when connected to a 9.3.x Essbase server or more recent.v Type IV: Default extraction type. An extraction type that in most cases

offers higher performance than type II.

Use type II or type IV extraction types for extracting data from an ASOapplication. Use any extraction type for extracting data from a BSOapplication.

Type I and III require that the Essbase data extractor is installed. For moreinformation, see “Installing the Essbase data extractor setup tool” on page14.

Buffer sizeApplies to Essbase and Planning. Select this option to specify the size ofthe internal buffer. This setting is typically left at the default of Auto.

Setting the buffer size too low can result in longer extraction times. Settingthe buffer size too high can result in the Essbase server beingunresponsive.

If the buffer size is set to Auto, the Cognos Integration Server calculates anappropriate buffer size that is based on the performance of the computer


that the Cognos Integration Server is running on, the members that areselected, and the performance of the Essbase server. The actual buffer sizethat the Cognos Integration Server uses is recorded in the SIS log aftereach data extraction. That buffer size is typically used as a starting point ifit becomes necessary to change the default 'Buffer size'.

For large and sparse databases, it might be advantageous to set Buffer sizeto a larger value than the one chosen by the Cognos Integration Serverwhen you use type IV extraction.

Only available for Essbase extraction type II and type IV.

Extraction threadsApplies to Essbase and Planning. Select this option to specify themaximum number of extraction threads that are used during an extraction.This setting is typically left at its default of Auto. A higher number puts ahigher load on the Essbase server during a data extraction. Setting theextraction threads to 1 loads the Essbase server the least, but can lengthenthe data extraction time.


Lock database during extractionApplies to Essbase and Planning. Select this option to prevent updates tothe Essbase database during extraction.


Planning+ optionsYou can specify the Planning+ extraction options.

Planning+ options are only available for Planning selections.

The following list describes the data extraction options for Planning+ selections:

Extract Planning DetailsEnables the extraction of Planning details data.

Account AnnotationsExtracts account annotations.

Cell TextExtracts cell text.

Supporting DetailsExtracts supporting details.

Planning Unit AnnotationsExtracts Planning unit annotations.

Form AnnotationsExtracts form annotations.

Configuring an Essbase selectionYou can configure an Essbase selection in IBM Cognos Integration Server.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, select an Essbase selection.3. Click Open.4. Click the Data Extraction Options tab.


5. Set the extraction options.6. Set the column selections.

Selecting members from an Essbase outlineYou can specify the members to select by using the Essbase outline.

About this task

The Essbase outline is a visual representation of a relational star schema in amultidimensional data storage system. The following graphic shows an Essbaseoutline. The background text is deliberately blurred.

The following example uses the Essbase Sample Basic selection to illustrate theselection of a member. You can select the descendants of the highlighted memberdown to and including all level 2 members below the selected member. Thefollowing graphic shows member selection from an Essbase outline. Thebackground text is deliberately blurred.

To locate a member in the outline tree, in the Member Selections window,right-click the member name and click Locate Member. The Essbase outline treeopens on the selected member.

Procedure1. In the IBM Cognos Integration Server navigation tree, click Selection Manager.2. In the Selection List window, select an Essbase selection.3. Click Open.

Figure 2. Essbase outline

Figure 3. Essbase outline member selection


4. Expand the outline by clicking the plus sign (+) of the outline node to find thedesired member. Alternatively, use the search function to search for a member.For more information, see“Searching for outline members” on page 53.

5. To select a member, right-click the member and select a member selectionfunction. The member appears in the Member Selections window.Attention: For some function types, it is possible to specify an inputparameter to the function. The input parameters available depend on theoutline. Some members might not allow all functions to be selected, dependingon their position in the outline. For example, top members have the ancestorsfunctions disabled. If extraction type I is selected, only level 0 (zero) membersof the spin dimension can be selected.

Selecting members from a list of Essbase membersAs an alternative to selecting members from the Essbase outline, you can selectmembers from a list of all members of an outline.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click an Essbase selection.3. Click Open.4. Click Add Member > Add Members From List.5. Select a member from the list or type the name of the member. You can also

specify a function and a parameter. For more information, see “Selectingmembers from an Essbase outline” on page 46.

6. Click Add.7. Click Done.

Selecting server-side substitution variablesYou can select members from substitution variables that are defined on the Essbaseserver.

About this task

The following substitution variables are supported by the IBM Cognos IntegrationServer:v A single member, for example: 100-10.v A list of members, for example: 100-10, 200, 300, 400-10.v A level range, for example: Sep:Dec, which resolves into Sep, Oct, Nov, Dec. All

members are at the same level.v A generation range, for example: Qtr2::Qtr4, which resolves into Qtr2, Qtr3,

Qtr4. All members are at the same generationv A combination of the preceding values, for example: 100:300, 100-10, 200-20.


Attention:

Members that contain a colon (:) or a comma (,) must be enclosed in quotationmarks ("") or brackets ([]).

The Cognos Integration Server supports only members from the same dimensionin the same substitution variable.

In the Member Selections section, the name of the substitution variable is prefixedwith an ampersand (&) to distinguish it from outline members.

When you search the outline for a substitution variable, the member that thevariable resolves into is found.

For substitution variables that resolve into more than one member:v The function is set to Select Member.v If a custom name is entered, only the first member is given the custom name.v When you are locating a substitution variable in the outline by right-clicking the

variable and selecting Locate, the first member is located.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click a selection.3. Click Open.4. Click Add Member > Add Server-Side Substitution Variables.5. Select a substitution variable from the Variable list and select a Function and a

Parameter.6. Click Add. Repeat the process to add more substitution variables.

Essbase column selectionsYou can specify which column data to extract in a selection.

You can specify the data to extract in the Column Selections window.

The following table describes the Essbase column selections:

Table 1. Essbase column selections

Column Description

Export Selects a specific dimension to be extracted during metadataExtraction. The Export check box also selects the dimension columnsthat are included in the fact table.

Attention: The dimension columns of attribute dimensions areempty if the corresponding base dimensions are not selected. If youuse extraction type III and a text file target, the values of dimensioncolumns of attribute dimensions are empty.

Column Lists all dimensions of the outline.


Table 1. Essbase column selections (continued)

Column Description

Spin The spin dimension is a concept unique to Oracle Essbase andPlanning selections. It is used when you extract data from amulti-dimensional Essbase database to a two-dimensionalrow-column relational database or a flat file.

v Type I data extraction - For each selected member of the spindimension, a block of data based on the member selections of theother dimensions and the data extraction options settings isextracted. If no stored members of the spin dimension areselected, all stored level zero members (leaf nodes) of the spindimension are used in the extraction.

For best performance, select a dense dimension with the leastnumber of level zero members.

Only level zero members of the spin dimension can be selected.For more information, see “Selecting members from an Essbaseoutline” on page 46.

v Type II and IV data extraction - For best performance, select asparse dimension. Any members of the spin dimension can beselected.

v Type III data extraction - Select a dense dimension. Any membersof the spin dimension can be selected.

Sort This setting controls the ordering of the dimension columns in thefact table. The first column is the one with a Sort value of 0 (zero).Values must be zero-based and no larger than the number ofdimensions minus one.

Essbase member selectionsYou can view the member data that is extracted in a selection.

You can view the data to extract in the Member Selections window.

The following list describes the Essbase member selections:

MemberName of the selected member.

FunctionThe member selection function that is selected for the current member.Right-click the function of a selected member to change the memberselection function and the input parameter for the function.

ParameterInput parameter for the selected function.

Custom NameThe custom name replaces the member name in the CUSTOM_NAME fieldof the respective dimension table and in the dimension columns of the facttable. Only member selections of function type Select Member can have acustom name.

DimensionThe dimension to which the selected member belongs.


Essbase extraction typesThe IBM Cognos Integration Server provides four extraction types and severaloptions for extracting data from Essbase BSO (Block Storage Option) and EssbaseASO (Aggregate Storage Option) models.

For Essbase ASO models, only extraction type II and type IV are available. ForEssbase BSO models, all extraction types are available. Consider some of thefollowing situations:v To extract a large portion of the database (more than 10,000,000 intersection

points or if the database is sparsely populated), type I, III, or IV will typicallyoutperform type II.

v To extract data with many dynamic calculations from both dense and sparsedimensions, type II or type IV might be the best choice.

v To use Intelligent Extraction from an Essbase cube, type I is the only choice.

Because Essbase cubes and their internal structure can vary, you can experimentwith different extraction types to get the best performance.

The following table describes the extraction type options that are supported forrelational targets:

Table 2. Extraction type options supported for relational targets

Option Type I Type II Type III Type IV

ASO Extraction X X

BSO Extraction X X X X

Set Output DataPrecision

X X X X

Set Record Commit X X X X

Set Load TypeAppend

X X X X

Set Load TypeRefresh

X X X X

Set Load Type Merge X X X X

Extract Data withAliases

X X X X

Implicit ShareOverride

X X

Intelligent Extraction X

Custom Data ValueFilter

X

Custom ScopeControl

X X

Set Extraction Buffer X X

Set ExtractionThreads

X X

Essbase Server SideExport

X X

Client Side Export X X

SQL Server BulkInsert

X X


Table 2. Extraction type options supported for relational targets (continued)


Ideal Cube ExtractionSpace

Unlimited 10,000,000 orless

Unlimited Unlimited

Extraction of a SparseCube / Intersection

X X (Performancemight bereduced)

X X

Extraction ofDynamicCalculations

X (Dense dataonly)


X

Essbase versionsupported

9.3 and above 9.3 and above 9.3 and above 9.3 and above

The following table describes the extraction type options that are supported fortext file targets:

Table 3. Extraction type options supported for text file targets


ASO Extraction X X

BSO Extraction X X X X

Set Output DataPrecision

X X X X

Set Record Commit X X X X

Set Load TypeAppend

X X X X

Set Load TypeRefresh

X X X X

Set Load Type Merge X

Extract Data withAliases

X X X

Implicit ShareOverride

X X

Intelligent Extraction X

Custom Data ValueFilter

X

Custom ScopeControl

X X

Set Extraction Buffer X X

Set ExtractionThreads

X X

Essbase Server SideExport

X X

Client Side Export X

SQL Server BulkInsert

Ideal Cube ExtractionSpace

Unlimited 10,000,000 orless

Unlimited Unlimited


Table 3. Extraction type options supported for text file targets (continued)


Extraction of a SparseCube / Intersection


X X

Extraction ofDynamicCalculations

X (Dense dataonly)


X

Essbase versionsupported

9.3 and above 9.3 and above 9.3 and above 9.3 and above

Planning selection configurationConfiguring a Planning selection consists of configuring an Essbase selection andsetting the specific extraction options for Planning+.

For information about configuring an Essbase Selection, see “Configuring anEssbase selection” on page 45. It is not necessary to configure any Essbase columnor member selections if only Extract Planning Details is selected.

For information about setting the Planning+ specific options, see “Planning+options” on page 45.

HFM selection configurationConfiguring a Hyperion Financial Management (HFM) selection consists of settingthe extraction options and selecting one or more members from each dimension ofthe HFM outline to extract if the data extraction option is selected.

Selecting members from an HFM outline

You can select members from an HFM outline the same way as you do when youconfigure an Essbase selection.

For information about configuring an Essbase selection, see “Configuring anEssbase selection” on page 45.

Selecting members from an HFM member list

Selecting members from an HFM member list is different from selecting membersfrom an Essbase member list.

For more information, see “Selecting members from an HFM member list.”

HFM member selection and column selections

The HFM Member Selections and Column Selections windows are similar to thosein Essbase, except that there is no Spin column and no Parameter column.

For more information, see “Essbase column selections” on page 48 and “Essbasemember selections” on page 49.

Selecting members from an HFM member listYou can select members from member lists that are defined on the HFM server.


About this task

Separate member lists are defined for each dimension.

Procedure1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, click an HFM selection.3. Click Open.4. To see the member lists defined for a dimension, from the member outline,

right-click any member of the dimension and click Select Members frommember list.

5. Do one of the following steps:v To select all members from a member list, double-click the member list, or

alternately select the member list and click All. When the selection is run, allmembers from the member list are included in the member selection, whichis based on the member list definition that exists at the time the selection isrun.

Note: To distinguish a member list from outline members, the name of themember list is prefixed with an ampersand character (&) in the MemberSelections window.

v To select individual members from a member list, select the member list andclick Select Members. In the Add Members From Member List window,select members from the Member list. When finished, click Done.

Searching for outline membersYou can create a selection to specify which data to import.

Procedure1. From the Selection Manager, click New Essbase Selection, New Planning

Selection, or New HFM Selection.2. To search for a specific member in an outline, enter the name or a part of the

name in the Search box above the outline and click the search button. You canclick the search button drop-down button to modify the search options. Tosearch for more matches of the same name, click the search button again.

Running a selectionYou can run a selection from the Selection Manager UI, or a from a command line.

Procedure1. Under Selection Manager in the navigation tree, click the selection that you

want to run.2. From the Selection Manager toolbar, click Run. If Run is unavailable, click

Save. The selection is validated before it is run.

The Log ViewerThe Log Viewer provides a list of log records for viewing errors, warnings, orother information from the IBM Cognos Integration Server.


The Cognos Integration Server has a single logging point where all log informationis directed to a table in the Integration Server database. You can filter and exportthe log view.

In addition to standard logging of Cognos Integration Server activity, a process IDis assigned to all log records associated with the running of a selection during theprocess run. You can use the process ID as a filter to track the history of a process.For more information, see “Filtering the log results.”

The Log Viewer contains the following information:

LogIDLog record identifier.

Entry DateDate and time the log record was entered.

ProcessIDEach selection run has a unique process ID. If the Process ID is -1, then thelog record is not associated with a selection run.

Type Type of log record:v ERRORS: Selection run failures and errors in the program.v WARNINGS: A selection run is completed but the results might not be

as expected.v INFORMATION: Information and debug messages.

Entry Description of the log entry.

SourceModule and method where the log record was recorded. This informationis helpful for IBM support.

MachineServer that generated the log entry.

User Operating system user that performed the operations that result in the logentry.

Selection NameSelection (if any) that was running when the log entry was generated.

Process NameName of the process, such as Essbase, that generated the log entry.

Filtering the log resultsYou can filter log records in the Log Viewer to make the log information aboutIBM Cognos Integration Server activity history more readable.

Procedure

In the IBM Cognos Integration Server tree, click Log Viewer.v To filter based on type, from the Log Viewer window, click the Errors, Warnings,

or Information tabs to display or hide the log types that you want to filter. Anycombination of log types can be displayed by toggling these tabs. When youchange any of these tabs, the records that are displayed in the viewer arerefreshed with the new filter options.

v To filter based on other criteria, specify one of the following filter options:


– Filter on days filters on the specified number of days from the current day.Click Refresh to update the view.

– Filter on date range filters on a specified date range. Click Refresh to updatethe view.

– Filter on Selection filters on selection job runs. Choose the selection that youwant and click Refresh. This option displays all log records associated withprocess IDs corresponding to the selected selection. This option can becombined with any other filter option.

– ProcessID filters on a specific process ID. Type the process ID in ProcessIDand click Refresh. This option can be combined with any other filter option.

Viewing individual log entriesThe list of log entries might be too long to view from the list view. You can displayan expanded window of the log record.

Procedure1. In the IBM Cognos Integration Server tree, click Log Viewer.2. To view all the details of a specific log record, select the log record and click

View Item.

Exporting the log viewYou can use the IBM Cognos Integration Server Log Viewer to export log recordsto a text file.

Procedure1. In the Cognos Integration Server tree, click Log Viewer.2. To export log records, do one of the following steps:

v To export all records in the log view, click Export, specify a file and pathwhere the log records are to be exported.

v To export selected records in the log view, select the log records that youwant, right-click and click Export Selected Records to File, and specify a fileand path where the log records are to be exported.

3. Click Save.

The Command Line UtilityYou can use the Command Line Utility to run IBM Cognos Integration Serverselections from a command line.

The utility can run selections from a command console (interactive mode) or froma batch file as part of an automation process (batch mode).

The Command Line Utility returns the following return codes:v 1: Indicates an errorv 0 (zero): Indicates that the process terminated normally

Interactive modeYou can use the IBM Cognos Integration Server Command Line Utility to runselections from a command console.


Interactive Mode

To run the Command Line Utility in interactive mode, from the Start menu clickIBM Cognos Integration Server > Command Line Utility.

Attention: The first time that you use the utility, you might have to clickCommand Line Utility twice to allow for the initialization to take place.

Type commands one at a time in the syntax that is shown, and then press thecarriage return key.

The Command Line Utility in interactive mode supports the following commands:

Table 4. Command Line Utility interactive mode commands

Command Description

DELETE_SELECTION_ALL * Deletes all selections.

DELETE_SELECTION_ALL * selection ID |selection name *

Deletes the selection with the ID of selectionID or name of selection name.

EXIT Exits the command line utility.

EXPORT_ALL directory name Exports all selections and connections to thedirectory name directory.

EXPORT_CONNECTION_ALL directory name Exports all connections to the directory namedirectory.

EXPORT_CONNECTION connection ID | connectionname directory name

Exports the connection with the ID ofconnection ID or name of connection name tothe directory name directory.

EXPORT_SELECTION_ALL directory name Exports all selections to the directory namedirectory.

EXPORT_SELECTION selection ID | selectionname directory name

Exports the selection with the ID of selectionID or name of selection name to the directoryname directory.

HELP Displays the online help.

IMPORT_CONNECTION_ALL directory name * Imports all connections from the directoryname directory.

IMPORT_CONNECTION connection file name * Imports a previously exported connectionfrom the connection file name name.

IMPORT_SELECTION selection file name sourceconnection ID | source connection name targetconnection ID | target connection name *

Imports a previously exported selection fromthe selection file name name and assigns thesource and target connections to it.

LIST Displays a list of all selections.

LIST selection ID Displays a list of all members of theselection with the ID of selection ID.

LIST selection name Displays a list of all members of theselection with the name of selection name.

LIST_CONNECTIONS Displays a list of all connections.

RUN ALL Runs all selections.

RUN ALL Start ID - End ID Runs all selections with IDs greater than orequal to Start ID and smaller than or equalto End ID.

RUN ALL selection ID1 selection ID2 ... selectionIDn

Runs all specified selections.


Table 4. Command Line Utility interactive mode commands (continued)

Command Description

RUN selection ID Runs the selection with the ID of selectionID.

RUN selection name Runs the selection with the name of selectionname.

RUN selection ID command file name ... commandfile name

Runs the selection with the ID of selection IDwith extra input or modification commandsfrom one or more command files.

RUN selection name command file name ...command file name

Runs the selection with the name of selectionname with extra input or modificationcommands from one or more command files.

RUN selection ID dimension member function[custom name]

Runs the selection with the ID of selectionID. If the dimension member member isselected in the selection, its function isupdated. If the member is not selected, it isadded to the selection before it is run. Usethe custom name to change the name of themember as it appears in the output from therun.

function is one of the following: MEMBER,CHILDREN, ICHILDREN, DESCENDANTS,IDESCENDANTS, ANCESTORS,IANCESTORS, LEVMBRS, or PARENT

Attention: Not all functions are valid for allmembers. Typically, you use the CognosIntegration Server Manager to check whichfunction is valid for each member.Right-click a member in the IntegrationServer Manager outline to see all validfunctions for that member.

RUN selection name dimension member function[custom name]

Runs the selection with the name of selectionname. If the dimension member member isselected in the selection, its function isupdated. If the member is not selected, it isadded to the selection before it is run. Usethe custom name to change the name of themember as it appears in the output from therun.


Attention: Not all functions are valid for allmembers. Typically, you use the CognosIntegration Server Manager to check whichfunction is valid for each member.Right-click a member in the IntegrationServer Manager outline to see all validfunctions for that member.


Table 4. Command Line Utility interactive mode commands (continued)

Command Description

UPDATE_SELECTION selection ID | selectionnameselection file name [source connection ID |source connection nametarget connection ID |target connection name] *

Updates an existing selection with settingsfrom a previously exported selection file andoptionally assigns the source and targetconnection to it. The selection keeps itsoriginal source and target connections if nosource and target connections are specified.

Attention: Parameter values, such as member names, selection names, commandfile names, and custom names that contain spaces, must be enclosed in doublequotation marks.

Commands that are marked with an asterisk (*) make permanent changes to yourIntegration Server configuration.

Batch modeYou can use the IBM Cognos Integration Server Command Line Utility to runselections from a batch file as part of an automation process.

To run the Command Line Utility in batch mode, open a command promptwindow and type C:\Program Files(x86)\IBM\Cognos IntegrationServer\ICIS\startICISCMD.bat, followed by the command parameters, whereC:\Program Files(x86)\IBM\Cognos Integration Server is the installationdirectory, or add the equivalent command to a batch file and run it.

The Command Line Utility in batch mode supports the following commandparameters:

Table 5. Batch mode command parameters

Parameter Description

RUN selection ID Runs the selection with the ID of selectionID.

RUN selection name Runs the selection with the name of selectionname.

RUN selection ID command file name ... commandfile name

Runs the selection with the ID of selection IDwith extra input or modification commandsfrom one or more command files.

RUN selection name command file name ...command file name

Runs the selection with the name of selectionname with extra input or modificationcommands from one or more command files.


Table 5. Batch mode command parameters (continued)


RUN selection ID dimension member function[custom name]

Runs the selection with the ID of selectionID. If the dimension member member isselected in the selection, its function isupdated. If the member is not selected, it isadded to the selection before it is run. Usethe custom name to change the name of themember as it appears in the output from therun.


Attention: LEVMBRS indicates all level 0members below member.

Not all functions are valid for all members.Typically, you use the Integration ServerManager to check which function is valid foreach member. Right-click a member in theIntegration Server Manager outline to see allvalid functions for that member.

RUN selection name dimension member function[custom name]

Runs the selection with the name of selectionname. If the dimension member member isselected in the selection, its function isupdated. If the member is not selected, it isadded to the selection before it is run. Usethe custom name to change the name of themember as it appears in the output from therun.


Attention: Not all functions are valid forall members. Typically, you use theIntegration Server Manager to check whichfunction is valid for each member.Right-click a member in the IntegrationServer Manager outline to see all validfunctions for that member.

RUN ALL Runs all selections.

RUN ALL Start ID - End ID Runs all selections with IDs greater than orequal to Start ID and smaller than or equalto End ID.

RUN ALL selection ID1 selection ID2 ... selectionIDn

Runs all specified selections.

DELETE_SELECTION_ALL * Deletes all selections.

DELETE_SELECTION_ALL * selection ID |selection name *

Deletes the selection with the ID of selectionID or name of selection name.


Table 5. Batch mode command parameters (continued)


EXPORT_ALL directory name Exports all selections and connections to thedirectory name directory.

EXPORT_CONNECTION_ALL directory name Exports all connections to the directory namedirectory.

EXPORT_CONNECTION connection ID | connectionname directory name

Exports the connection with the ID ofconnection ID or name of connection name tothe directory name directory.

EXPORT_SELECTION_ALL directory name Exports all selections to the directory namedirectory.

EXPORT_SELECTION selection ID | selectionname directory name

Exports the selection with the ID of selectionID or name of selection name to the directoryname directory.

IMPORT_CONNECTION_ALL directory name * Imports all connections from the directoryname directory.

IMPORT_CONNECTION connection file name * Imports a previously exported connectionfrom the connection file name name.

IMPORT_SELECTION selection file name sourceconnection ID | source connection name targetconnection ID | target connection name *

Imports a previously exported selection fromthe connection file name name and assigns thesource and target connections to it.

UPDATE_SELECTION selection ID | selectionnameselection file name [source connection ID |source connection nametarget connection ID |target connection name] *

Updates an existing selection with settingsfrom a previously exported selection file andoptionally assigns the source and targetconnection to it. The selection keeps itsoriginal source and target connections if nosource and target connections are specified.



Command File SyntaxThe command file is a text file with instructions for the Command Line Utility.

Place each command on a separate line in the file. Lines that begin with asemicolon (;) are considered comments and are ignored. For more information, see“Setting extraction options” on page 37.

The Command Line Utility supports the following command syntax:

Table 6. Command file options

Command syntax Description

CREATE_STAR_SCHEMA ON | OFF Turns creation of the metadata and datatables on or off.

DATA_PRECISION Precision Precision specifies the number of decimalplaces the extracted data is rounded to.Valid range is 0 - 15.


Table 6. Command file options (continued)


DELETE_ALL Precision Deletes all selected members from thedimension dimension from the selectionbefore it is run. The command is ignored ifthe dimension does not exist.

DELETE dimension member Deletes the dimension member member fromthe Selection before it is run. The commandis ignored if either the dimension or themember does not exist.

DIMENSION_TABLE_LAYOUT PARENT_CHILD |BALANCED | QLIKVIEW | MDM member

This option determines the format of themetadata tables.

EXTRACT_DATA ON | OFF | QLIKVIEW Turns extraction of data on or off.

EXTRACT_EXPANDEDFILTERS ON | OFF Turns extraction of expanded filters on oroff.

EXTRACT_FILTERS ON | OFF Turns extraction of filters on or off.

EXTRACT_METADATA ON | OFF Turns extraction of metadata on or off.

EXTRACT_PLANNINGFILTERS ON | OFF Turns extraction of planning filters on or off.

EXTRACT_USERGROUPS ON | OFF Turns extraction of user groups on or off.

EXTRACT_USERS ON | OFF Turns extraction of users on or off.

EXTRACTION_TYPE TYPE_I | TYPE_II |TYPE_III | TYPE_IV

Sets the extraction type. Essbase or Planningonly.

FACT_TABLE_NAME fact table name This parameter sets the name of the facttable where data is extracted to.

FACT_TABLE_FORMAT NARROW | WIDE Sets the layout of the fact table.

LOAD_TYPE refresh | append | merge Specifies how data is written to the targetconnection.

MEMBER_VALUES member_names| member_ID This option determines the format of thedimension column values of the fact table.

PREFIX Prefix Sets the star schema prefix.

RECORD_COMMIT Record Commit Number Record Commit Number specifies the numberof extracted data records that are held inmemory before they are committed to thetarget connection.

REPLACE Selection Member New Member Use this parameter to replace a member of aselection with a new member. The selectedfunction remains unchanged.




SOURCE_CONNECTION source connection name |source connection ID [source connection username | source connection password [RDBMSconnection user name | RDBMS connectionpassword]]

The source connection that is used by thisselection. The source connection can bespecified as the name of the connection orthe ID of the connection. The sourceconnection name is the name that is shown inthe Connection Manager connection list.

Specify source connection user name and sourceconnection password to modify the user nameand password of the connection.

Specify RDBMS connection user name andRDBMS connection password to modify theRDBMS user name and password of theconnection. This only applies to Planningconnections.

User names and passwords are ignored if asource connection does not require them.

SPARSE_DISCOVERY ON | OFF Turns sparse discovery on or off.

TARGET_CONNECTION target connection name |target connection ID [target connection username | target connection password]

The target connection that is used by thisselection. The target connection can bespecified as the name of the connection orthe ID of the connection. The targetconnection name is the name that is shown inthe Connection Manager Connection List.Specify target connection user name and targetconnection password] to modify the user nameand password of the connection.

User names and passwords are ignored if atarget connection does not require them.




UPDATE dimension [dimension member function[custom name [EntityParentMember]]

If the dimension member member is selected,its function is updated. If the member is notselected, it is added to the Selection before itis run. Use the custom name to change thename of the member as it appears in theoutput from the run.

function is one of: MEMBER, CHILDREN,ICHILDREN, DESCENDANTS,IDESCENDANTS, ANCESTORS,IANCESTORS, LEVMBRS, or PARENT

You can use EntityParentMember to specifythe parent of an entity member. The defaultentity parent member is used ifEntityParentMember is not specified. Tospecify EntityParentMember without setting acustom name, set custom name to " " (a spacethat is enclosed in double quotation marks).

Attention: LEVMBRS indicates all level 0members below member.

Not all functions are valid for all members.Typically, you use the Integration ServerManager to check which function is valid foreach member. Right-click a member in theIntegration Server Manager outline to see allvalid functions for that member.

UPDATE_COLUMNS dimension [dimension ...dimension]

Use this command to modify the exportcolumn selections. For example:

UPDATE_COLUMNS Year, "Pkg Type",Measures

In this example, only the Year, Pkg Type,and Measures columns are exported,regardless of what was selected in the UI.The sort order of the columns is:

Year 0

Pkg Type 1

Measures 2

USER_ALIAS ON | OFF When set to ON, member aliases areextracted to the target connection fact tablerather than the member name. Essbase /Planning Only.




For version 10.2.1, the following command file options are for HFM:

Table 7. HFM command file options


EXTRACT_HFM_PM_DATA ON | OFF Specifies that process management data isextracted from members that are selected inthe Member Selections window.

EXTRACT_HFM_CELL_TEXT ON | OFF Specifies that cell text is extracted frommembers that are selected in the MemberSelections window or that all cell text for theHFM application is extracted.

EXTRACT_HFM_CLID ON | OFF Specifies that cell line item details areextracted from members that are selected inthe Member Selections window, or that allcell line item details for the HFM applicationare extracted.

EXTRACT_HFM_CH ON | OFF Specifies that cell history is extracted frommembers that are selected in the MemberSelections window or that all cell history forthe HFM application is extracted.

EXTRACT_HFM_JE ON | OFF Specifies that journal entries are extractedfrom members that are selected in theMember Selections window, or that alljournal entries for the HFM application areextracted.

INCLUDE_HFM_CELL_STATUS ON | OFF Extracts the cell status.

SUPPRESS_HFM_ZEROS ON | OFF Specifies that intersection points with datavalues of zero (after rounding up to thespecified data precision) are not extracted.

SUPPRESS_HFM_SEM ON | OFF Suppresses the extraction of duplicate EntityMember data intersection points from HFMwhere the Entity name and Parent name arethe same.

SUPPRESS_HFM_DAM ON | OFF Specifies that no intersection point where theAccounts member is dynamic is extracted.

SUPPRESS_HFM_RPEM ON | OFF Suppresses the extraction of data fromintersection points from HFM where theEntity member's parent is not the defaultentity parent.

For version 10.2.1, the following command file options are for Planning:

Table 8. Planning command file options


EXTRACT_PLANNING_DETAILS ON | OFF Extracts Planning details data.

EXTRACT_PLANNING_AA ON | OFF Extracts account annotations.

EXTRACT_PLANNING_CT ON | OFF Extracts cell text.

EXTRACT_PLANNING_SD ON | OFF Extracts supporting details.

EXTRACT_PLANNING_UA ON | OFF Extracts unit annotations.

EXTRACT_PLANNING_FA ON | OFF Extracts form annotations.


For version 10.2.1, the following command file options are for Essbase, Planning,and Cognos Integration Server star schema:

Table 9. Essbase, Planning, and Cognos Integration Server star schema command fileoptions


BUFFER_SIZE AUTO, 200, 500, 1000, 2000,5000, 10000, 20000, 50000, 100000, 200000,500000, 1000000, 2000000

Applies to Essbase and Planning. Specifiesthe size of the internal buffer. This setting istypically left at the default of Auto. Formore information, see the Buffer size sectionin “Data extraction options” on page 40.

CUSTOM_DATA_VALUE_FILTER filter Limits the Essbase selection output that isbased on standard Essbase IF conditionsyntax. Only available for Essbase extractiontype I. For more information, see the CustomData Value Filter section in “Data extractionoptions” on page 40.

CUSTOM_SCOPE_CONTROL scope Applies to Essbase and Planning. Providesan alternative way of entering memberselection criteria in addition to the functionprovided by the Selection Manager. Notavailable for Essbase extraction type II andtype IV. For more information, see theCustom Scope Control section in “Dataextraction options” on page 40.

EXTRACTION_THREADS AUTO, 1,2, 3, 4, 5 ,6, 7,8, 9, 10, 11, 12, 13, 14, 15, 16, 32, 64

Applies to Essbase and Planning. Select thisoption to specify the maximum number ofextraction threads that are used during anextraction. This setting is typically left at itsdefault of Auto. A higher number puts ahigher load on the Essbase server during adata extraction. Setting the extractionthreads to 1 loads the Essbase server theleast, but can lengthen the data extractiontime.

Only available for Essbase extraction type IIand type IV.

IMPLICIT_SHARE_OVERRIDE OFF | GENMBRS| LEVMBRS | PARENTCHILD | UDA

Applies to Essbase and Planning. Appliesonly to Essbase extraction type I. For moreinformation, see the Implicit Share Overridesection in “Data extraction options” on page40.

INTELLIGENT_EXTRACTION ON | OFF Applies to Essbase and Planning. Specifiesthat only data that is changed since the lastextraction is extracted. For moreinformation, see the Intelligent extractionsection in “Oracle Essbase Extraction” onpage 4.

LEVEL_0_OPTIMIZATION ON | OFF Applies to Essbase and Planning. Optimizesthe Sparse Discovery for selections withmember functions Select Members fromhere based on Level and level = 0 (zero).

LOCK_DATABASE ON | OFF Applies to Essbase and Planning. Preventsupdates to the Essbase database duringextraction. Only available for Essbaseextraction type II and type IV.


Table 9. Essbase, Planning, and Cognos Integration Server star schema command fileoptions (continued)


MAX_UDAS 1-64 Applies only to Essbase and Planning. Setsthe maximum number of UDA columns inthe Essbase dimension tables. For moreinformation, see “Essbase dimension table”on page 74.

MDM_VERSION version The Master Data Manager version numberfor MDM metadata exports.

SET_DATA_AS_CLEAN ON | OFF Sets the data blocks to Clean after theextraction. Available for Essbase extractiontypes I and III.

STORED_MEMBERS_ONLY ON | OFF Applies to Essbase and Planning. Specifiesthat dynamic members are left out of theextraction. Available for Essbase extractiontypes I and III.

SUPPRESS_ESSBASE_MISSING ON | OFF Specifies that all intersection points that aredesignated #Missing or NULL are notextracted.

SUPPRESS_ESSBASE_ZERO ON | OFF Applies to Essbase and Planning. Specifiesthat intersection points with data values ofzero (after rounding up to the specified dataprecision) are not extracted.

USE_ALIAS ON | OFF Applies to Essbase, Planning, and CognosIntegration Server star schema. Specifies thatmember aliases (rather than the membernames) are extracted to the target connectionFACT table . This option has no effect if theFACT Table Member Values option is set toUse Member ID Reference. If you useextraction type III and a text file target, theexported dimension values will be membernames.

For version 10.2.1, the following command file options are for Essbase, Planning,and HFM selections:

Table 10. Essbase, Planning, and HFM command file options


BH_I_FORMAT LEVEL | GENERATION Specifies either generation format, in whichmetadata columns are ordered from the topdown, or level format, in which metadatacolumns are ordered from the bottom up.For more information, see the ExtractMetadata section in “Metadata extractionoptions” on page 40.

GENERATION_NAME Dimension (case sensitive)Generation GenerationName

Specifies a name for each dimension'sgeneration. These names are used as therespective dimension table's column namesfor each generation.


Table 10. Essbase, Planning, and HFM command file options (continued)


LEVEL_NAME Dimension (case sensitive) LevelLevelName

Specifies a name for each dimension's level.These names are used as the respectivedimension table's column names for eachlevel.


Chapter 4. IBM Cognos Integration Server star schemadefinition

The star schemas that are created by the IBM Cognos Integration Server follow thetypical format of a single fact table and multiple dimension tables.

The star schema tables that are created by the Cognos Integration Server supportOracle Essbase Integration Services (EIS) in the form of structure and metadatacontent. The Oracle Essbase Integration Services use specific member attributecodes in dimension tables for building Oracle Essbase cubes.

When the Create Star Schema option is selected for selections that contain arelational target connection, a table is created for each dimension in the selectionand one fact table that is called FACT is created to contain source connection data.

All tables that are created by the Cognos Integration Server are generic and canaccommodate any type of data. As a result, the data types that are used are astandard varchar(255) data type for text and a numeric data type for numbers.

The Cognos Integration Server does not create indexes or relationships between thetables. After you create a star schema, you can modify the table definition of datatypes, indexes, and relationships. However, if you change these table properties,make sure that the metadata or data to be written to these tables by the CognosIntegration Server can be accommodated. For example, do not delete fields that arecreated by the Cognos Integration Server. Also, do not modify the following partsof the table structure:v Table namesv Field names that are created by the Cognos Integration Server

Dimension tables that are created from Essbase and HFM source connections havedifferent table structures under the parent-child hierarchy layout. However, there isno difference between Essbase and HFM source connections that use theGenerations or Level format (translation table). The table definitions for thestandard Parent-Child format are described first, followed by the definition of theGenerations and Level format.

Attention: All target star schemas must be in their own databases. The IntegrationServer does not support mixing target star schemas with other application databasetables.

Star schema fundamentalsThe dimensional star schema is a relational schema in which a central fact tableholds numerical data.

Joined to the fact table are dimension tables that hold the corresponding metadata.Metadata is data about data, and includes information such as hierarchalrelationships and consolidation attributes.


The Essbase outline, as shown in the following image, is a manifestation of arelational star schema in a multidimensional data storage system. A star schema isoften referred to as a cube, even though it is stored in a relational database. TheEssbase outline is an excellent visual representation of a cube and the relatedhierarchies, attributes, and calculations. The following is an example of an Essbaseoutline. The background text is deliberately blurred.

Attention: A dimensional star schema is not required to build an Essbase outline,but a dimensional star schema simplifies maintenance, especially if used withOracle Essbase Integration Services (EIS).

In summary, the IBM Cognos Integration Server is designed to generate andmaintain a dimensional star schema (data and metadata).

Attention: It is not necessary that the output target of the Cognos IntegrationServer is a relational star schema. The target can be a text file.

Parent-child formatIn the parent-child star schema format, the dimension tables have one record foreach member in the dimension.

Each record specifies the member name, its related attribute, and its immediateparent. The hierarchy relationship is implicitly represented recursively by thePARENT and CHILD fields. Because both Essbase and HFM both do not allowduplicate member names, each record in a dimension table is unique, based on theCHILD field.

Figure 4. A typical star schema

Figure 5. Essbase outline


Attention: Both Essbase and HFM use the Shared Member concept to supportalternative hierarchies. In these cases, child members might be duplicatedunderneath a separate roll-up structure with a storage attribute of SHARED.

Generation formatYou can use the Integration Server to create the star schema of a target connectionin a Generation format. In this format, each record in the dimension table reflects alevel zero member and its ancestors, beginning from Generation One.

The fact table contains one column for each dimension that is selected in therespective selection, as in the Parent-Child format. The difference is that thecolumn name reflects the maximum Generation column in the respectivedimension table.

The Integration Server automatically balances ragged hierarchies that exist fromeither Essbase or HFM. The balancing is done by using the same member name ineach of the Generation columns where a generation does not exist. For example, ifthe Accounts dimension has a maximum of five generations, the columns in theAccounts dimension table is Generation1, Generation2, Generation3, Generation4and Generation5. If the Profit hierarchy in Accounts only goes to Generation2 withSales and COGS as the only descendants of Profit, the records for the Profithierarchy looks as follows:

Table 11.

Generation1 Generation2 Generation3 Generation4 Generation5

Accounts Profit Sales Sales Sales

Accounts Profit COGS COGS COGS

This balances the hierarchy required by some relational Hyperion reporting tools,such as Hyperion Intelligence. The following tables illustrate the Generation formatfor dimension and fact tables.

Attention: Data type is given for SQL Server, DB2 / Oracle. For Unicodeapplications, the varchar(xx) or varchar2(xx) columns are nvarchar(xx) ornvarchar2(xx).

Table 12. Generation format for dimensions

Column name Data type Description

Generation1 varchar(255) or varchar2(255) GENERATION1 is replacedwith the name of generation1 that is specified in theTranslation table of theselection. The values consistof the member name at thatgeneration.

Generation2 varchar(255) or varchar2(255) GENERATION2 is replacedwith the name of generation2 that is specified in theTranslation table of theselection. The values consistof the member name at thatgeneration.

Chapter 4. IBM Cognos Integration Server star schema definition 71

Table 12. Generation format for dimensions (continued)


Generationn varchar(255) or varchar2(255) GENERATIONn is replacedwith the name of the highestgeneration number of thedimension that is specified inthe Translation table of theselection. The values consistof the member name at thatgeneration.

Table 13. Generation format for fact tables


DIM1MAXGEN varchar(255) or varchar2(255) DIM1MAXGEN is replacedwith the name of the largestcorresponding dimensiongeneration that is specified inthe Translation table of theselection. The values consistof the member name at thatgeneration.

DIM2MAXGEN varchar(255) or varchar2(255) DIM2MAXGEN is replacedwith the name of the largestcorresponding dimensiongeneration that is specified inthe Translation table of theselection. The values consistof the member name at thatgeneration.

DIMnMAXGEN varchar(255)/ or archar2(255) DIMnMAXGEN is replacedwith the name of the largestcorresponding dimensiongeneration that is specified inthe Translation table of theselection. The values consistof the member name at thatgeneration.

DATA numeric(14,x) ornumber(14,x)

Actual data value of thedimension memberintersection. The precision ofthis field (x) is based on theData Precision option of theselection that is used tocreate the table.

STATUS varchar(100) or varchar2(100) Used only in the HFM facttable. STATUS is used todisplay the HFM dataintersection status that isprovided by HFM.

Level formatYou can use the IBM Cognos Integration Server to create the star schema of atarget connection in level format.


In level format, each record in the dimension table reflects a level-zero memberand its ancestors, beginning from the top level on its drill path. The fact tablecontains one column for each dimension that is selected in the respective selection,as in the parent-child format. The difference is that the column name reflects thelevel 0 column in the respective dimension table.

The Cognos Integration Server automatically balances ragged hierarchies that existfrom either Essbase, Planning, or HFM. The balancing is done by using themember name from the top level in each of the level columns where a level doesnot exist on the respective drill path. In the following example, the inventoryhierarchy has only two levels (0 and 1) so the Level2 column is completed with theinventory member name. The following example shows the level format in treeform:Profit

MarginSalesCost of Goods Sold

Total ExpensesMarketingPayrollMiscellaneous

InventoryOpening InventoryAdditionsEnding Inventory

RatiosMarginProfitProfit per Ounce

The following shows the level format in table form:

Table 14. Level format in table form

Level2 Level1 Level0

Profit Margin Sales

Profit Margin Cost of Goods Sold

Profit Total Expenses Marketing

Profit Total Expenses Payroll

Profit Total Expenses Miscellaneous

Inventory Inventory Opening Inventory

Inventory Inventory Additions

Inventory Inventory Ending Inventory

Ratios Ratios Margin

Ratios Ratios Profit

Ratios Ratios Profit per Ounce

When you use level format, you can change the name of each level column byusing the translation table, similar to the generation format.


Master data management formatMaster Data Management format is a specific format of Essbase and HFMmetadata extraction that satisfies the importation requirements of Hyperion MasterData Management Server.

The format is:

ActionAdd or ChangeProp

MDM VersionBased upon setting in selection - for example, UAT

HierarchyApp Name, DB name, and dimension

Node Parent Member (if ADD) or Child Member (if CHANGEPROP)

PropertyChild Member (if ADD) or PropertyName (if CHANGEPROP) - Note thatPropertyName can be any property established in MDM

Value 0 (if ADD) or relevant value based on the property (if CHANGEPROP)

For example:

ACTION,MDM_VERSION,HIERARCHY,NODE,PROPERTY,VALUE ,

Add,UAT,Sample Basic Market,Market,East,0

ChangeProp,UAT,Sample Basic Market,East,Alias1,East

ChangeProp,UAT,Sample Basic Market,East,Consolidation,+

ChangeProp,UAT,Sample Basic Market,East,Data Store,S

ChangeProp,UAT,Sample Basic Market,East,Time Balance,N

ChangeProp,UAT,Sample Basic Market,East,Skip,N

ChangeProp,UAT,Sample Basic Market,East,Variance,N

ChangeProp,UAT,Sample Basic Market,East,TwoPassCalc,N

Essbase dimension tableYou can view the column names and data types for the Essbase dimension table.

The data type is listed for SQL Server, DB2, and Oracle data targets. For Unicodeapplications, the varchar(xx) or varchar2(xx) data types are nvarchar(xx) ornvarchar2(xx).

The Essbase dimension table has the following columns with the followingdescriptions and data types:

ID Primary key field.

integer or int


DIMNAMEName of the respective dimension.

varchar(255) or varchar2(255)

PARENTParent member name to the current member.


CHILDMember name.


ALIAS1 - ALIAS10Up to 10 alias names. ALIAS1 is typically from the Default Alias Table.ALIAS2 is typically from an alternative Alias Table.


CONSOLIDATIONAggregation specifications with the outline. The following values arepossible:v +v -v *v /v %v ~


DATASTOREData storage types, as stored within Essbase. The following values arepossible:v S (stored)v N (never share)v O (label only)v SHARED (shared)v V (dynamic calc)v X (dynamic calc and store)


TIMEBALANCEEssbase time balance specifications, as defined in the Essbase outline. Thefollowing values are possible:v N (none)v F (first)v L (last)v A (average)


SKIP Essbase time balance skip specifications, as defined in the Essbase outline.The following values are possible:v N (none)


v M (skip missing)v Z (skip zeros)v B (skip missing and zeros)


VARIANCEEssbase variance specifications, as defined in the Essbase outline. Thefollowing values are possible:v E (expense)v N (non-expense)


TWOPASSCALCEssbase two-pass calc specifications, as defined in the Essbase outline. Thefollowing values are possible:v T (two-pass calc member)v N (no two-pass calc)


UDA1 - UDAnUser-defined attributes. 1 - 64 columns. For more information, see “Starschema options” on page 37.


ATTR_ASSOC1 - ATTR_ASSOC10Essbase attribute 1 - 10.


FORMULAEssbase member formula that is attached to the current member.

varchar(xx) or varchar2(xx)

The maximum size of the FORMULA column:v SQL Server, non-unicode: 4000v SQL Server, Unicode: 2000v Oracle, non-unicode: 4000v Oracle, Unicode: 2000v DB2, Unicode, and non-unicode: 2000

MBRCOMMENTEssbase member comment that is assigned to the current member.


CUSTOM_NAMEUser-defined custom name.


GENERATIONEssbase member generation.


LEVELEssbase member level.



SOVLE_ORDERSolve order.


HFM accounts dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) accounts dimension table.

The data type is listed for SQL Server, DB2, and Oracle data targets.

The HFM accounts dimension table has the following columns with the followingdescriptions and data types:


integer or int

DIMENSIONName of the respective dimension.




PARENTIDParent member ID assigned to the current member.

int or number

CHILDCurrent member name.


AGGREGATIONAggregation specification symbols for the current member. The followingvalues are possible:v +v -v ~ (no aggregation)




DESCRIPTIONCurrent member description.

varchar(8000) or varchar2 (8000)

UNIQUE_ALIASUnique alias for the current member.



DATA_STORAGEData storage type, as stored within HFM. The following values arepossible:v SHAREDv NEVER SHAREv STORE


ITEM_LEVELMember level.


ITEM_GENERATIONMember generation.


ACCOUNT_TYPE_1HFM account type specification. The following values are possible:v ASSETv BALANCEv CURRENCYRATEv DYNAMICv EXPENSEv FLOWv GROUPLABELv INCOMEv LIABILITYv NONFINANCIALv SYSTEMv TEXTv REVENUE


ACCOUNT_TYPEEssbase equivalent HFM account type specification. The following valuesare possible:v PL (profit or loss)v BS (balance sheet)v STAT (statistical account)


TIME_BALANCEHFM time balance specification. The following values are possible:v TB LASTv TB NONE


VARIANCE_REPORTINGHFM variance reporting specification. The following values are possible:v NON-EXPENSE


v EXPENSE


ISCALCULATEDWhether the data for an account is calculated by HFM. The followingvalues are possible:v True (calculated by HFM)v False (manually entered)


ISCONSOLIDATEDWhether the data for an account is consolidated to parent entities. Thefollowing values are possible:v True (consolidated to parent entities)v False (not consolidated to parent entities)


ISICP Whether the account is used in intercompany transactions. The followingvalues are possible:v Y (yes)v N (no)


PLUGACCTThe member ID of the account's plug account.


CUSTOM1TOPMEMEBERFirst account type attribute assigned to the current member.


CUSTOM2TOPMEMBERSecond account type attribute assigned to the current member.


CUSTOM3TOPMEMBERThird account type attribute assigned to the current member.


CUSTOM4TOPMEMBERFourth account type attribute assigned to the current member.


NUMDECIMALPLACESThe maximum number of digits to the right of the decimal point that theaccount supports.


USESLINEITEMSWhether the account allow line items. The following values are possible:v True (allowed)v False (not allowed)



ENABLECUSTOM1AGGRWhether the EnableCustom1Aggr attribute is enabled. The followingvalues are possible:v True (enabled)v False (attribute is disabled)








USERDEFINED1The UserDefined1 attribute for the account.






XBRLTAGSThe XBRL Tags attribute for the account.


SECURITYCLASSThe ID of the security class that is assigned to the account.


ICPTOPMEMBERThe member ID of the Intercompany Partner dimension member that isassigned as an account dimension member's ICPTopMember attribute.



ENABLEDATAAUDITWhether the ENABLEDATAAUDIT attribute is enabled. The followingvalues are possible:v True (enabled)v False (not enabled)

Attention: For HFM 3.5.1, this attribute is not supported and is set toFalse.


DEFAULTPARENTThe name of the default parent.


DEFAULTPARENTIDThe ID of the default parent.

int or number

PARENTSORTIDCHILDSORTID of parent member.

int or number

CHILDSORTID1-based ID for sorting members.

int or number

HFM entity dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) entity dimension table


The HFM entity dimension table has the following columns with the followingdescriptions and data types:


integer or int



PARENTParent member name that is assigned to the current member.



int or number




AGGREGATIONAggregation specification symbol for the current member. The followingvalues are possible:v +v -v ~ (no aggregation)








DATA_STORAGEData storage type as stored within HFM. The following values are possible:v SHAREDv NEVER SHAREv STORE






DEFCURRENCYThe member ID of the Value dimension member that represents the entity'sdefault currency.


ALLOWADJSWhether the entity allows journal entries. The following values arepossible:v True (journal entries are allowed)v False (journal entries are not allowed)


ISICP Whether the entity is used in intercompany transactions. The followingvalues are possible:v Y (yes)v N (no)



ALLOWADJFROMCHILDRENWhether the entity allows journal postings from its children. The followingvalues are possible:v True (journal postings from children are allowed)v False (journal postings from children are not allowed)


SECURITYCLASSThe ID of the security class that is assigned to the entity.


USERDEFINED1The value that is defined for the entity's UserDefined1 attribute.






HOLDINGCOMPANYThe name of the HoldingCompany.


HOLDINGCOMPANYIDThe ID of the HoldingCompany.

int or number

SECURITYASPARTNERThe name of the SecurityAsPartner.


SECURITYASPARTNERIDThe ID of the SecurityAsPartner.

int or number

ORGBYPERIODFILTERINGONWhether the entity has organization by period filtering enabled. Thefollowing values are possible:v True (enabled)v False (not enabled)





int or number



int or number


int or number

HFM scenario dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) scenario dimension table.


The HFM scenario dimension table has the following columns with the followingdescriptions and data types:


integer or int






int or number


















DEFAULTFREQThe ID number of the scenario dimension member's default frequency.


DEFAULTVIEWThe number that identifies the default view of the scenario dimensionmember.


ZEROVIEWFORNONADJThe member ID of the view dimension member that is assigned as theZeroViewForNonadj attribute.


ZEROVIEWFORADJThe member ID of the View dimension member that is assigned as theZeroViewForAdj attribute.


CONSOLIDATEYTDWhether the Scenario dimension member supports year-to-dateconsolidation. The following values are possible:v True (supported)v False (not supported)









SUPPORTPROCESSMANAGEMENTWhether the process management feature is enabled. The following valuesare possible:v True (enabled)v False (not enabled)


SECURITYCLASSThe ID of the assigned security class.


MAXIMUMREVIEWLEVELThe value that is assigned to the MaximumReviewLevel attribute.


USESLINEITEMSWhether the Scenario dimension member supports line items. Thefollowing values are possible:v True (supports)v False (does not support)


ENABLEDATAAUDITWhether the data audit attribute is enabled. The following values arepossible:v True (enabled)v False (not enabled)

Attention: For HFM 3.5.1, this attribute is not supported and is set toFalse.


DEFFREQFORICTRANSDefFreqForICTrans attribute.

Attention: For HFM 3.5.1, this attribute is not supported and is set to 0.





int or number


int or number


int or number


HFM year dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) year dimension table.


The HFM year dimension table has the following columns with the followingdescriptions and data types:


integer or int






int or number


















YEARRANGE_FIRSTThe first year in the range of valid years.


YEARRANGE_LASTThe last year in the range of valid years.



int or number


int or number

HFM period dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) period dimension table.


The HFM period dimension table has the following columns with the followingdescriptions and data types:


integer or int






int or number


















BASEFREQUENCYThe ID of the base frequency for the application.

int or number

FREQUENCYThe ordinal position of a period within the base frequency for theapplication.



int or number


int or number


HFM ICP dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) ICP dimension table.


The HFM ICP dimension table has the following columns with the followingdescriptions and data types:


integer or int






int or number


int or number
















SECURITYCLASSThe ID of the security class that is assigned to the Intercompany Partner.


PARENTIDParent member ID that is assigned to the current member.

int or number



HFM custom1- 4 dimension tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) custom1- 4 dimension table.


The HFM custom1- 4 dimension table has the following columns with thefollowing descriptions and data types:


integer or int






int or number



AGGREGATIONAggregation specification symbols for the current member. The followingvalues are possible:v +v -


v ~ (no aggregation)





varchar(8000) or varchar2 (8000)









ISCALCULATEDWhether the data for the Custom member is calculated by HFM. Thefollowing values are possible:v True (calculated by HFM)v False (data is manually entered)


SWITCHSIGNFORFLOWWhether the Switchsignforflow attribute for the Custom dimensionmember is enabled. The following values are possible:v True (enabled)v False (not enabled)


SWITCHTYPEFORFLOWWhether the Switchtypeforflow attribute for the Custom dimensionmember is enabled. The following values are possible:v True (enabled)v False (not enabled)









SECURITYCLASSThe ID of the security class.

int or number




int or number


int or number


int or number

HFM view and value dimension tablesYou can view the column names and data types for the Hyperion FinancialManagement (HFM) view and value dimension tables.


The HFM view and value dimension tables have the following columns with thefollowing descriptions and data types:


integer or int





PARENTIDParent member ID that is assigned to the current member.

int or number



















int or number


int or number

Essbase and HFM narrow fact tableYou can view the column names and data types for the Essbase and HyperionFinancial Management (HFM) narrow fact table.


The data type is listed for SQL Server, DB2, and Oracle data targets. For Unicodeapplications, the varchar(xx) or varchar2(xx) columns have the data typenvarchar(xx) or nvarchar2(xx).

The order of the DIMNAME1 - DIMNAMEn columns is determined by the Sortcolumn value of the Column Selections window.

The Essbase and HFM narrow fact table has the following columns with thefollowing descriptions and data types:

DIMNAME1 - DIMNAMEnDIMNAME1 - DIMNAMEn is the name of the columns 1 - n that areselected to be exported.

If Use Member Names is selected, the column values are member namesthat correspond to the CHILD field of the respective dimension table.

If Use Member ID Reference is selected, the column values are the IDsthat correspond to the ID field of the respective dimension table.

varchar(255) or varchar2(255) or int or number

The data type depends on the Fact Table Member Values setting. For moreinformation, see “Star schema options” on page 37.

DATA Contains the actual data value of the dimension member intersection. Theprecision of this field (x) is based on the Data Precision option of theSelection that is used to create the table.

numeric (14,x) or number(14,x)

STATUSOnly used in the HFM fact table. Used to display the HFM data cell statusthat is provided by HFM. The following cell status values are possible:v OK (OK)v Locked (locked)v OK SC (OK but system changed)v CH (needs chart logic)v TR (needs translation)v CN (needs consolidation)


AUDITIDWhen a data extraction is run, either from HFM or in Essbase, theIntegration Server adds or updates the AUDITID field in the fact table. TheAUDITID references a record in the fact audit table. This table has thesame name as the fact table, plus a suffix of _AUDIT.

int or number

Essbase and HFM wide fact tableYou can view the column names and data types for the Essbase and HyperionFinancial Management (HFM) wide fact table.



The ordering of the DIMNAME1 - DIMNAMEn columns is determined by the Sortcolumn value of the Column Selections window.

The Essbase and HFM wide fact table has the following columns with thefollowing descriptions and data types:

DIMNAME1 - DIMNAMEnDIMNAME1 - DIMNAMEn are the names of the columns 1 - n that areselected to be exported. The column values are member names thatcorrespond to the CHILD field of the respective dimension table.


WideMember1 - WideMembernWideMember1 - Widemembern are the names of the 1 - n Wide dimensionmember columns. The column values are the actual data values of thedimension member intersection. The precision of these fields (x) is basedon the Data Precision option of the Selection that is used to create thetable.

numeric(14,x) or number(14,x)

STATUSOnly used in the HFM fact table. Used to display the HFM data cell statusthat is provided by HFM. The following cell status values are possible:v OK (OK)v Locked (locked)v OK SC (OK but system changed)v CH (needs chart logic)v TR (needs translation)v CN (needs consolidation)


AUDITIDWhen a data extraction is run, either from HFM or in Essbase, theIntegration Server adds or updates the AUDITID field in the fact table. TheAUDITID references a record in the fact audit table. This table has thesame name as the fact table, plus a suffix of _AUDIT.

int or number

For more information on the wide dimension and the wide fact format, see “Starschema options” on page 37.

Planning account annotations fact tableYou can view the column names and data types for the Planning accountannotations fact table.


The Planning account annotations fact table has the following columns with thefollowing descriptions and data types:

DATABASEThe name of the planning database.



SCENARIOSThe Scenario dimension member.


VERSIONSThe Scenario version.


ENTITIESThe Entity dimension number.


ACCOUNTSThe Account dimension number.


DESCRIPTIONThe description for the account.


AUDITIDThe AUDITID references a record in the fact audit table. This table has thesame name as the fact table, plus a suffix of _AUDIT.

int or number

Planning cell text fact tableYou can view the column names and data types for the Planning cell text facttable.


The Planning cell text fact table has the following columns with the followingdescriptions and data types:

DATABASEName of the planning database.


TEXT Cell note contents.


<dimensions>One field for each dimension with cell text.


NOTE_IDID of the cell note.

int or number



int or number

Planning form annotations fact tableYou can view the column names and data types for the Planning form annotationsfact table.


The Planning form annotations fact table has the following columns with thefollowing descriptions and data types:



FORMName of the form.


FORM_IDID of the form.

int or number

TITLE The form title.


TEXT The contents of the annotations.


ANNOT_SEQAnnotation sequence identifier.

int or number

CREATEDCreation time and date.

datetime or date

AUTHORThe name of the author of the annotation.


AUTHOR_IDID of the author of the annotation.

int or number


int or number


Planning unit fact tableYou can view the column names and data types for the Planning unit fact table.


The Planning unit fact table has the following columns with the followingdescriptions and data types:

PLANNING_UNITName of the planning unit.


PLANNING_UNIT_IDID of the planning unit.

int or number

TITLE Planning unit title.


TEXT Planning unit contents.


SCENARIOPlanning unit scenario member.


VERSIONName of the version.


ENTITYPlanning unit Entity member.


ANNOT_SEQPlanning unit annotation sequence number.

integer or int

CREATEDCreation time and date.

datetime or date

AUTHORThe name of the author.


AUTHOR_IDID of the author.

int or number



int or number

Planning supporting details fact tableYou can view the column names and data types for the Planning supportingdetails fact table.


The Planning supporting details fact table has the following columns with thefollowing descriptions and data types:



DETAIL_DESCRIPTIONSupporting detail label.


OPERATOROperator that is associated with detail. The following values are possible:v 0 (ignore)v 1 (add)v 2 (subtract)v 3 (multiply)v 4 (divide)

char or char

POSITIONPosition order of the detail (0 based).

int or number

GENERATIONGeneration of the detail (0 based).

int or number

VALUEDetail value.

float or float

<dimensions>One field for each dimension with supporting details.


DETAIL_IDDetail identifier.

int or number


int or number


Audit tableThe AUDITID field in the fact Table references the AUDITID field in the AuditTable. The Audit table always has the same name as the fact table with theaddition of the suffix _AUDIT.


The Audit table has the following columns with the following descriptions anddata types:

AUDITIDThe ID of the entry.

int or number

SavedSelectionIDSelection ID used when the data extraction was run for the audit record.

int or number

SavedSelectionnameSelection name that is used when the data extraction was run for the auditrecord.


RecordDateDate and time the data extraction that is completed and the audit recordwas written.

DateTime or Date

SourceConnectionIDConnection ID for the source connection that is used in the Selection thatcreated the audit record.

int or number

SourceConnectionConnection name for the source connection that is used in the Selectionthat created the audit record.


LoadTypeLoad type that is used based on the Selection. The following values arepossible:v Refreshv Appendv Merge


SavedSelectionBinary representation of the Selection state at the time the Selection wasrun.

image or blob


Essbase filters tablesOracle Essbase filters can be extracted in both Essbase and Planning formats. Theformats are supported by the Integration Server to facilitate importing filters intoOracle Essbase or Hyperion Planning using the respective Hyperion utilities.

Both formats contain one row of filter data for each unique combination of a filterrow assigned to an Essbase Application, Database and User.


The Essbase filter table has the following columns with the following descriptionsand data types:

FilterNameThe name of the filter.


EsbApplicationOracle Essbase application name that the filter belongs to.


EsbDatabaseOracle Essbase database name that the filter belongs to.


UserNameOracle Essbase user that the filter is assigned to.


EsbFilterFilter Member Specification as defined in Oracle Essbase for the respectivefilter row.

varchar(xx) or varchar2(xx)

Tip: For unicode applications, this columns is a maximum of 2000characters.

AccessAccess level granted to the EsbFilter. The following values for the field arepossible:v Readv Writev Nonev MetaRead


The Planning filter table has the following columns with the following descriptionsand data types:










EsbMemberOracle Essbase member that the Access and EsbFunction is applied to forthe current filter row.




EsbFunctionOracle Essbase member expansion function that is applied to theEsbMember value for the current filter row. For example, @CHILDREN is apossible value for this field. This value grants the level specified in Accessto the children of the EsbMember value.


The Expanded filter table has the following columns with the followingdescriptions and data types:









EsbMemberOracle Essbase member that the Access and EsbFunction is applied to forthe current filter row.





EsbFunctionOracle Essbase member expansion function that is applied to theEsbMember value for the current filter row. For example, @CHILDREN is apossible value for this field. This value grants the level specified in Accessto the children of the EsbMember value.


Essbase users tablesThe Essbase users metadata is extracted into two separate tables. The first table is asimple list of usernames. The second table is a list of usernames and theirrespective user groups.


The Essbase users table has the following column names with the followingdescriptions and data types:

UserNameName of user.


UserTypeADMINISTRATOR or USER


ApplicationName of the application that the user has access to.


DatabaseName of the database that the user has access to.


AccessThe user's access rights to the application or database. The followingvalues are possible:v N (none)v a combination of the following values:

– R (read)– W (write)


– C (calc)– L (DBLOAD)– D (DBDESIGN)


The Essbase user group table has the following columns with the followingdescriptions and data types:

UserGroupName of a security group as specified in the Oracle Essbase.


UserNameUsername as specified in the Oracle Essbase.


HFM process management fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) process management fact table.


The HFM process management fact table has the following columns with thefollowing descriptions and data types:

ScenarioThe Scenario dimension member name of the process unit.


Year The Year dimension member name of the process unit.


Period The Period dimension member name of the process unit.


Entity The Entity dimension member name of the process unit.


EntityParentThe Entity Parent dimension member name of the process unit.


Value The Value dimension member name of the process unit.


Time The time of the process level change.

datetime and date

User The name of the user that made the process level change.


ActionThe action taken.



State The process unit state after the process level change.


CommentsAny comments added to the process level change.



int or number

HFM journal items fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) journal items fact table.


The order of the DIMNAME1 - DIMNAMEn columns is determined by the Sortcolumn value of the Column Selection window.

The HFM journal items fact table has the following columns with the followingdescriptions and data types:

DIMNAME1 - DIMNAMEnDIMNAME1 - DIMNAMEn is the name of the columns 1 - n selected to beexported. If Use Member Names is selected, the column values aremember names that correspond to the CHILD field of the respectivedimension table. If Use Member ID Reference is selected, the columnvalues are the IDs that correspond to the ID field of the respectivedimension table.


The data type depends on the setting for the Fact Table Member Valuesoption. For more information, see “Star schema options” on page 37.

JOURNAL_IDThe journal ID uniquely identifies the journal.

int or number

JOURNAL_LABELThe name of the journal.


JOURNAL_DATAThe data in the cell's journal entry. The precision of this field (x) is basedon the Data Precision option of the Selection used to create the table.


ENTRY_IDThe entry ID identifies the journal item within the journal.

int or number


DEBIT_CREDITWhether the journal item is a credit or debit item. The following values arepossible:v C (credit item)v D (debit item)


DESCRIPTIONThe description of the journal item.



int or number

HFM journals fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) journals fact table.


For the PERIOD, VALUE, SINGLE_ENTITY, and SINGLE_PARENT columns in thetable, the data type depends on the value that you select for the Fact TableMember Values setting.v If the Use Member Names value is selected, the data type is varchar(255) or

varchar2(255).v If the Use Member ID Reference value is selected, the data type is int or

number.

For more information, see “Star schema options” on page 37.

The HFM journals fact table has the following columns with the followingdescriptions and data types:

JOURNAL_IDThe journal ID uniquely identifies the journal.

int or number

JOURNAL_LABELName of the journal.


TYPE Type of the journal. The following values are possible:v ARL (auto-reversal)v ARV (auto-reversing)v REG (regular)


STATUSStatus of the journal. The following values are possible:v A (approved)v P (posted)


v R (rejected)v S (submitted)v W (working)


BALANCE_TYPEBalance type of the journal. The following values are possible:v B (balanced)v E (balanced by entity)v U (unbalanced)


JOURNAL_GROUPThe name of the group the journal has been assigned to if the journal isassigned to a group.


DESCRIPTIONA description of the journal.


PERIODThe journal's period dimension.


The data type depends on the Fact Table Member Values setting that isselected.

VALUEThe journal's value dimension.


SECURITYCLASS_IDThe ID of the security class the journal belongs to.

int or number

SINGLE_ENTITYThe journal's entity dimension if journal is a single entity journal



SINGLE_PARENTThe journal's entity parent dimension if journal is a single entity journal.



CREATED_USERName of user that created the journal.


POSTED_USERName of user that posted the journal.



APPROVED_USERName of user that approved the journal.


CREATED_DATE_TIMEDate the journal was created.


POSTED_DATE_TIMEDate the journal was posted.


APPROVED_DATE_TIMEDate the journal was approved.



int or number

HFM cell line item details fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) cell line item details fact table.



The HFM cell line item details fact table has the following columns with thefollowing descriptions and data types:




DATA Contains the line item data. The precision of this field (x) is based on theData Precision option of the Selection used to create the table.






int or number

HFM cell text fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) cell text fact table.



The HFM cell text fact table has the following columns with the followingdescriptions and data types:




TEXT The cell text.




AUDITIDThe AUDITID references a record in the fact audit table. This table has thesame name as the fact table, plus the suffix _AUDIT.

int or number

HFM cell history fact tableYou can view the column names and data types for the Hyperion FinancialManagement (HFM) cell history fact table.



The HFM cell history fact table has the following columns with the followingdescriptions and data types:





SERVERThe name of the application server on which the data change was made.


USERNAMEName of the user who made the change.


TIME_MODIFIEDTime and date the change was made.

DateTime Date

ACTIVITYThe change activity. The following values are possible:v ALLOCATEv CELL_LOGICv CHART_LOGICv CONSOLIDATIONv CUSTOM_LOGICv DATA_CLEARv DATA_COPYv DATA_ENTRYv DATA_EXTRACTv DATA_EXTRACT_HALv DATA_LOADv DATA_RETRIEVALv IDLEv JOURNAL_ENTRYv JOURNAL_POSTINGv JOURNAL_RETRIEVALv JOURNAL_TEMPLATE_ENTRYv JOURNAL_UNPOSTINGv LOGOFFv LOGONv LOGON_FAILUREv MEMBER_LIST_EXTRACTv MEMBER_LIST_LOADv MEMBER_LIST_SCAN


v METADATA_EXTRACTv METADATA_LOADv RULES_EXTRACTv RULES_LOADv RULES_SCANv SECURITY_EXTRACTv SECURITY_LOADv SECURITY_SCANv TRANSLATION


VALUEContains the cell values that the data changes resulted in. The precision ofthis field (x) is based on the Data Precision option of the Selection used tocreate the table.


AUDITIDThe AUDITID references a record in the fact audit table. This table has thesame name as the fact table, plus the suffix _AUDIT.

int or number


Notices

This information was developed for products and services offered worldwide.

This material may be available from IBM in other languages. However, you may berequired to own a copy of the product or product version in that language in orderto access it.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service. This document maydescribe products, services, or features that are not included in the Program orlicense entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.


Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Software GroupAttention: Licensing3755 Riverside Dr.Ottawa, ONK1V 1B7Canada

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.


This Software Offering does not use cookies or other technologies to collectpersonally identifiable information.

Trademarks

IBM, the IBM logo and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “ Copyright andtrademark information ” at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of

Microsoft Corporation in the United States, other countries, or both.v UNIX is a registered trademark of The Open Group in the United States and

other countries.v Java and all Java-based trademarks and logos are trademarks or registered

trademarks of Oracle and/or its affiliates.

Notices 115

http://www.ibm.com/legal/copytrade.shtml

http://www.ibm.com/legal/copytrade.shtml

Index

AAudit table 101audit table persistence parameters 22

Bbatch mode 58

Cchannel registration

satellite servers 18cloning connections 26cloning selections 36command file syntax 60command line utility 56, 58configuration files

setting 18configuring Essbase selections 45Connection Manager 24connection parameters 27

DB2 33Essbase 29HFM 31Oracle 32Planning 29satellite server 34SQL Server login 32SQL Server trusted connection 31star schema 28text file 34TM1 27

connectionscloning 26creating 24deleting 26editing 26exporting 26ID 24importing 27satellite server 25testing 25viewing 27

creating connections 24custom data value filters 4custom name mapping parameters 19custom scope control 4

Ddata extraction audit 7database column names

mapping 12database table names 12database tool

setting 12deleting connections 26deleting selections 36

dimension tablesEssbase 74HFM accounts 77HFM custom1- 4 91HFM ICP 90HFM period 88HFM scenario 84HFM view and value 93HFM year 87

Dimension tablesHFM entity 81

Eediting connections 26editing selections 35Essbase

column selections 48extraction types 50member list selection 47member selection 46member selections 49

Essbase and HFM narrow fact table 95Essbase and HFM wide fact table 95Essbase data extractor

installing 14setting properties 15starting 15

Essbase dimension table 74Essbase filters tables 102Essbase outline 46Essbase selections

configuring 45Essbase users tables 104exporting connections 26exporting selections 37extraction options

data 40metadata 40Planning+ 45star schema 37

Ffact table field length parameters 20fact table persistence parameters 22fact tables

Essbase and HFM narrow 95Essbase and HFM wide 95Essbase filters 102Essbase users 104HFM cell history 110HFM cell line item details 109HFM cell text 110HFM journal items 106HFM journals 107HFM process management 105Planning account annotations 96Planning cell text 97Planning form annotations 98


fact tables (continued)Planning supporting details 100Planning unit 99

fact TablesAudit 101

Ggeneration format 40, 71

HHFM accounts dimension table 77HFM cell history fact table 110HFM cell line item details fact table 109HFM cell text fact table 110HFM custom1- 4 dimension table 91HFM entity dimension table 81HFM extraction parameters

setting 21HFM ICP dimension table 90HFM journal items fact table 106HFM journals fact table 107HFM list members

selecting 53HFM period dimension table 88HFM process management fact table 105HFM scenario dimension table 84HFM view and value dimension tables 93HFM year dimension table 87

IIBM Cognos Integration Server

overview 3IBM DB2 database

initializing 14importing connections 27importing selections 36Integration Server

basics 9tools 10

Integration Server Managerstarting 10

intelligent extractionsetting up 5

interactive mode 56

Llarge data values parameters 23, 24level format 40, 73license key

viewing 18log entries

viewing 55log records

exporting 55log results

filtering 54log viewer

using 54

Mmaster data management format 74member selection validation parameters 23metadata extraction options 40Microsoft SQL Server database

initializing 12

Nname quotes parameters 22new features 1

in version 10.2.1 1

Oopening selections 35Oracle database

initializing 13Oracle Essbase extraction

options 4Oracle Essbase metadata extraction 6Oracle Essbase security extraction 6Oracle Hyperion Financial Management extraction 7Oracle Hyperion Planning data extraction 7outlines

searching for members 53

Pparameters

audit table persistence 22custom name mapping 19fact table field length 20fact table persistence 22large data values 23, 24member selection validation 23name quotes 22password persistence 21table suffix 20Unicode 23

parent-child format 70password persistence parameters 21Planning account annotations fact table 96Planning cell text fact table 97Planning form annotations fact table 98Planning supporting details fact table 100Planning unit fact table 99

Ssatellite servers channel registration 18searching for outline members 53selection information

specifying 37Selection Manager

options 10using 35

selection optionsTM1 39

selectionscloning 36creating 35deleting 36editing 35exporting 37


selections (continued)extraction options 37HFM 52importing 36opening 35Planning 52running 53

server-side substitution variablesselecting 47

specifying selection information 37spin dimensions 48SQLite database

initializing 13

star schemafundamentals 69

Ttable suffix parameters 20testing connections 25

UUnicode parameters 23

Index 119

IBM Cognos Integration Server Version 10.2.1...

Documents

Transcript of IBM Cognos Integration Server Version 10.2.1...