Cognos Integration Server Administration Guidepublic.dhe.ibm.com/software/data/cognos/... · data,...

Cognos Integration Server AdministrationGuide

IBM

Contents

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

What's new in IBM Cognos Integration Server........................................................ 1New features in IBM Cognos Integration Server version 10.2.3................................................................ 2New features in IBM Cognos Integration Server version 10.2.2.1.............................................................2New features in IBM Cognos Integration Server version 10.2.2................................................................ 2

New features...........................................................................................................................................2New features in IBM Cognos Integration Server version 10.2.1................................................................ 2

New features...........................................................................................................................................2

Overview...............................................................................................................3SAP BW data extraction............................................................................................................................... 3Oracle Essbase data extraction................................................................................................................... 4

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

IBM Cognos Integration Server fundamentals........................................................ 7Starting the Integration Server Manager.....................................................................................................8Integration Server Tools.............................................................................................................................. 8

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

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

Installing the Essbase data extractor setup tool...................................................................................... 12Setting Essbase data extractor properties.......................................................................................... 13Setting up the Essbase data extractor manually.................................................................................14

Viewing the license usage......................................................................................................................... 16Configuration file options.......................................................................................................................... 16

Audit table persistence........................................................................................................................ 16Channel registration for Cognos Integration Server satellite servers................................................ 16Culture.................................................................................................................................................. 17Data value field length in star schema fact tables.............................................................................. 17Display culture......................................................................................................................................18Fact table persistence.......................................................................................................................... 18Fact table and column name quotation marks....................................................................................18HFM custom dimensions name mapping............................................................................................ 18HFM extract calculated data................................................................................................................ 19HFM extract derived data.....................................................................................................................19HFM clusters with multiple nodes....................................................................................................... 19Large data values..................................................................................................................................20Maximum number of LINK arguments.................................................................................................20Password persistence.......................................................................................................................... 20Software license metric........................................................................................................................20

ii

Table suffixes........................................................................................................................................21Use TM1 MDX extractor........................................................................................................................21Use Unicode RDBMS table format....................................................................................................... 21Validate member selections before you run the command-line utility.............................................. 22

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

The Selection Manager.............................................................................................................................. 25Creating a selection..............................................................................................................................26Opening a selection..............................................................................................................................26Deleting a selection..............................................................................................................................26Cloning a selection............................................................................................................................... 26Importing a selection........................................................................................................................... 27Exporting a selection............................................................................................................................27Extraction options................................................................................................................................ 27Essbase selection configuration.......................................................................................................... 46Planning selection configuration..........................................................................................................52HFM selection configuration................................................................................................................ 53TM1 selection configuration.................................................................................................................54SAP BW InfoCube selection and configuration................................................................................... 55SAP BW InfoQuery selection and configuration..................................................................................57Star schema selection configuration................................................................................................... 58Searching for outline members............................................................................................................59Searching for outline members in a list view.......................................................................................59Running a selection.............................................................................................................................. 62

Connection parameters............................................................................................................................. 62Source connection type parameters....................................................................................................62Target connection type parameters.....................................................................................................75

Move data...................................................................................................................................................79Move data from TM1 cubes to SAP BW InfoCubes or DSOs............................................................... 79Move data from SAP BW InfoCubes or InfoQuery to TM1.................................................................. 82

The Log Viewer...........................................................................................................................................88Filtering the log results........................................................................................................................ 89Viewing individual log entries.............................................................................................................. 89Exporting the log view.......................................................................................................................... 89

The Command Line Utility......................................................................................................................... 90Interactive mode.................................................................................................................................. 90Batch mode.......................................................................................................................................... 94Command File Syntax.......................................................................................................................... 97

IBM Cognos Integration Server star schema definition........................................104Star schema fundamentals..................................................................................................................... 105Parent-child format................................................................................................................................. 106Generation format................................................................................................................................... 106Level format............................................................................................................................................. 108Master data management format............................................................................................................109Essbase dimension table.........................................................................................................................110HFM accounts dimension table...............................................................................................................112HFM entity dimension table.................................................................................................................... 116HFM scenario dimension table................................................................................................................118

iii

HFM year dimension table.......................................................................................................................121HFM period dimension table................................................................................................................... 122HFM ICP dimension table........................................................................................................................124HFM custom1- 4 dimension table...........................................................................................................125HFM view and value dimension tables....................................................................................................127Essbase and HFM narrow fact table........................................................................................................128Essbase and HFM wide fact table........................................................................................................... 129Planning account annotations fact table................................................................................................ 130Planning cell text fact table.....................................................................................................................130Planning form annotations fact table......................................................................................................131Planning unit fact table............................................................................................................................132Planning supporting details fact table.................................................................................................... 133Audit table................................................................................................................................................134Essbase filters tables...............................................................................................................................134Essbase users tables............................................................................................................................... 136HFM process management fact table..................................................................................................... 137HFM journal items fact table................................................................................................................... 138HFM journals fact table........................................................................................................................... 139HFM cell line item details fact table........................................................................................................141HFM cell text fact table............................................................................................................................141HFM cell history fact table.......................................................................................................................142SAP BW metadata table.......................................................................................................................... 144TM1 dimension table............................................................................................................................... 144TM1 fact table..........................................................................................................................................145CIS Star Schema metadata table............................................................................................................ 146

Notices..............................................................................................................146©............................................................................................................................................................... 147

Index................................................................................................................ 149

iv

Introduction

This document provides information that is intended for system administrators responsible for using IBM®

Cognos® Integration Server to set up extractions and to work with supported connections.

Overview

Use Cognos Integration Server to extract specialized cube data from various sources, such as OracleEssbase, Oracle Hyperion Planning, and Oracle Hyperion Financial Management. You can then work withthis source data in a target relational reporting application.

IBM Cognos Integration Server includes the following features:

• Automates data extraction and streamlines the process of dynamically generating target schemas thatsupport data warehousing and single source reporting.

• Extracts Oracle Hyperion cube data, metadata, and security profiles for loading into open-standardreporting formats or IBM Cognos TM1®.

• Performs extractions on a continuous basis to update external reporting and analysis applications.• Ensures that important hierarchies and drill paths that reflect the business are preserved in the target

relational reporting application.• Provides IT departments with access to data while finance users can continue to use cube technology.

Finding information

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

Accessibility features

IBM Cognos Integration Server does not currently support accessibility features that help users with aphysical disability, such as restricted mobility or limited vision, to use this product.

Forward-looking statements

This documentation describes the current functionality of the product. References to items that are notcurrently available may be included. No implication of any future availability should be inferred. Any suchreferences are not a commitment, promise, or legal obligation to deliver any material, code, orfunctionality. The development, release, and timing of features or functionality remain at the solediscretion of IBM.

What's new in IBM Cognos Integration Server

Knowing what features are new, changed, deprecated, or removed helps you plan your upgrade anddeployment strategies and the training requirements for your users.

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

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

Introduction 1

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



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

New features in IBM Cognos Integration Server version 10.2.3In Cognos Integration Server version 10.2.3 there are new features.New Star Schema Connection Manager

You can use the Star Schema Connection Manager to create, edit, test, and delete connections. Formore information, see “The Star Schema Connection Manager” on page 64.

Support for BW/4HANA extractionYou can now extract data and metadata from SAP BW/4HANA. For more information, see “SAP BWdata extraction” on page 3

Support for ODBC source connectionYou can now use an ODBC connection as the source for a CIS Star Schema connection. For moreinformation, see “RDBMS parameters panel” on page 65.

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

There is a new list view available. For more information, see “Searching for outline members in a list view”on page 59.

There is a new SAP BW DataStore Object (DSO) target connection.

There is a new SAP BW InfoCube target connection.

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

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

You can now use an InfoCube or InfoQuery on a SAP BW server as a source connection for CognosIntegration Server. For more information, see “SAP BW source connection parameters” on page 63.

Cognos Integration Server 10.2.2 supports Oracle EPM 11.1.2.4.

You can now use Cognos Access Management (CAM) namespaces and Security Assertion MarkupLanguage (SAML) authentication for TM1 connections.

IBM Cognos Integration Server 10.2.2 will be the last version to support 32-bit operating systems

Cognos is committed to supporting the latest technologies being used by our customers. As we moveforward in our support for these newer technologies, Cognos Integration Server 10.2.2 will be the lastreleases to support 32-bit operating systems.

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 for Cognos Integration Server toupdate your RDBMS or flat file star schema. You can also use a Cognos Integration Server star schema asa source connection. For more information, see “IBM Cognos Integration Server star schema connectionparameters” on page 64 and “IBM Cognos TM1 source connection parameters” on page 62.

2 Cognos Integration Server Administration Guide

There are now two new selection types: Cognos TM1 and Cognos Integration Server star schema. Formore information, see “Cognos TM1 selection star schema options” on page 29 and “Star schemaoptions” on page 28.

You can now extract from Hyperion cube data (Essbase, HFM, Planning) in level format or generationformat. For more information, see the Extract Metadata section in “Metadata extraction options” on page33.

There are now more command file options. For more information, see “Command File Syntax” on page97.

Overview

Use the IBM Cognos Integration Server to automate the extraction and distribution of business processmanagement (BPM) data to relational data stores and other IBM Cognos Business Intelligence (BI)applications.

You can use Cognos Integration Server to extract the information from your BPM applications into a BIwarehouse or any other BI application or reporting system.

You can also use Cognos Integration Server to share data, proprietary structures, calculations, businessrules, supporting detail, and security information in many applications. System administrators can use thegraphical user interface to create and manage complex data movements between applications eithermanually or by using automated operations with full auditing and notification. Cognos Integration Serveralso facilitates single-source reporting, continuous planning, and transaction drill-through.

Key features of Cognos Integration Server

Cognos Integration Server provides the following key features:

• With Cognos Integration Server, you can move your SAP BW InfoCubes and InfoQueries data to TM1 onpremise and TM1 in the Cloud.

• Cognos Integration Server extends your BPM capabilities by extracting and transforming any level ofdata, metadata, and security information from Oracle Essbase, Oracle Hyperion Planning, and OracleHyperion Financial Management for use in other enterprise applications or reporting systems.

• Use the automated extraction capabilities of Cognos Integration Server to enable real-time planning,calculations, and updates to move your data as necessary.

• Cognos Integration Server performs multiple, parallel extractions without taking your applicationsoffline.

• Structures and extraction selections can be viewed, defined, and modified. You can save the requireddata transformations, mappings, and calculations.

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

SAP BW data extractionIBM Cognos Integration Server can extract data and metadata from SAP BW Info Cubes, Info Queries, andBW/4HANA.

Data extraction from InfoCubes and InfoQueries is implemented by using MDX. The SAP BW MDXimplementation has an upper limit to the amount of data that can be extracted in one operation. The IBMCognos Integration Server overcomes that limitation by splitting any requests into chunks small enoughfor the SAP BW server to handle.

For InfoCubes, an extra extraction type based on the RSDRI_INFOPROV_READ_RFC BAPI is available.

Overview 3

Cognos Integration Server offers advanced features like cycle detection for dimensions created in TM1targets and member selection compatibility validation. Cognos Integration Server supports mapping ofSAP BW display names and technical names to TM1 namespaces.

Member name formats and alias name formats for TM1 targets based on SAP BW display names andtechnical names are extra supported features.

Oracle Essbase data extractionIBM Cognos Integration Server optimizes the performance of Essbase data extraction.

Extraction using the calculation engine

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

Intelligent extraction

Each data block within Oracle Essbase can have a clean or dirty status. A status of dirty indicates that avalue in the block has changed since the last intelligent extraction calculation script was run against it.The Cognos Integration Server uses the clean or dirty status of each data block within the database. Whenyou use intelligent extraction, data blocks with a status of dirty are extracted and data blocks with astatus of clean are ignored. Only data that has changed, rather than the entire data set specified in theselection, is exported. Intelligent extraction can improve data extraction times because typically only asmall amount of data that must 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 the Load Type option is setto Merge and that data suppression is turned off. This is critical because data changed from a number to 0or #Missing is still extracted to the target connection to update the existing value. If Suppress Zeros orSuppress Missing are turned on, no records are exported and the record in the target connection containsthe original value, leaving the target data out of sync with the Essbase database.

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

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

For more information about intelligent calculation in Oracle Essbase, see the Essbase AdministratorsGuide.

Custom data value filters

Use custom data value filters to limit the Essbase selection output that is based on standard Essbase IFcondition syntax. Custom data value filtering is similar to the custom formula function in a selection, butat the selection level rather than at the member selection level.

For more information about custom data value filtering, see “Data extraction options” on page 34.

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 Essbase calculation functions.This control is also used with the implicit share extraction feature, for example using LEVELS,GENERATIONS, or UDAs to define the data to 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” on page 34.


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

Setting up an intelligent Essbase data extractionYou can use intelligent extraction to reduce data extraction times when only a small amount of data thatneeds to be updated in the target connection of the selection is changed.

Procedure

1. Run an IBM Cognos Integration Server extraction with the following options:a) On the Star Schema Options tab, select Create Star Schema (if not previously created).

You can use any fact table format, any fact table member 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, under

Suppression select Zeros and Missing, and select Type I as the Extraction 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.d) On the Data Extraction Options tab, change the Load Type to Merge, change Suppression to No

Suppression, select Intelligent Extract, and select Set data as clean.7. Save this new extraction. Use the Windows Task Scheduler and a batch file to schedule the extraction

to run every 2 to 10 minutes (recommended). For example:

@ECHO *** STARTING ESSBASE EXTRACTION *** >> .\BAT_STAT.TXTDATE /t >> .\BAT_STAT.TXTTIME /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.TXTDATE /t >> .\BAT_STAT.TXTTIME /t >> .\BAT_STAT.TXT

Typically, you can run the Full Extract selection weekly and either drop and recreate the star schema,or truncate the tables and reload with the Refresh option. Over a week, records with a null value thatrepresent prior values or a non-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, andcalculations. There are three primary formats:

• Parent-child format• Balanced hierarchy format• Hyperion master data management format

For more information, see “IBM Cognos Integration Server star schema definition” on page 104.

Overview 5

The parent-child format is good for ragged hierarchies. This format also provides all outline metadataattributes, such as alternative alias tables, user-defined attributes, member formulas, and calculationlogic such as solve order.

The balanced hierarchy format is used to create conforming hierarchies from a ragged hierarchy. You usea balanced hierarchy to re-create the same drill path that a user has inside of the multidimensionalapplication in a relational reporting environment.

The Hyperion master data management (MDM) format extracts metadata in the MDM 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 33.

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

You can extract the following data:

• supporting detail• cell notes• account annotations• planning unit annotations• form annotations

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

For further improvements in extraction speed, the Cognos Integration Server HFM data extraction enginetakes advantage of multi-CPU servers. Before HFM processing is complete, the Cognos Integration Servercontinues to generate a new batch of intersection points, submits them to HFM, and so on. For moreinformation about setting the maximum number of outstanding requests to the HFM API, see HFMextraction parameters. The more CPUs in use with the Integration, the more HFM requests that can beprocessed in parallel, and the faster the extraction. However, the benefit of adding more requests to HFMbeyond a certain number decreases. Typically, the ExtractionThreads value is set to twice the number ofCPUs on the HFM server.

HFM metadata extraction is identical to Essbase metadata extraction. For more information, see“Metadata extraction options” on page 33.

Data extraction auditData extraction auditing creates a correlation between each data extraction and the selection that wasused in the data extraction.

The audit table is a data table that is created in the relational target database. When data extractionauditing is enabled, a fact table audit record is added to the audit 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 hasa unique ID for each record. The ID value is also stored in the AUDITID field of each fact table record sothat each data record in the fact table has a reference to the audit table record.

For example, to determine the age of fact table data records, a SQL query can be built linking therelationship between the fact table AUDITID and the ID field in the audit record.

For more information about the contents of the audit table, see “Audit table” on page 134.

Attention: Data extraction auditing can slow down a selection run. You can turn both auditing andselection state preservation on or off. For more information, see “Setting Selection Manageroptions” on page 9.

IBM Cognos Integration Server fundamentals

You can use the IBM Cognos Integration Server to extract multidimensional data from SAP BW, OracleEssbase, HFM, and Planning applications into TM1, a relational database management system (RDBMS)or text file format.

Configuring the IBM Cognos Integration Server involves the following activities:

• Set the Cognos Integration Server configuration options.

For more information, see “Configuration file options” on page 16.• Use the Connection Manager to configure connections to the SAP BW, TM1, and Hyperion application

sources and to the target TM1 servers, RDBMS databases, or text files.

For more information, see “The Connection Manager” on page 22.• Use the Selection Manager to select a source and a target connection and to select the data to extract

from the source.

For more information, see “The Selection Manager” on page 25.• Run selections to extract data.

For more information, see “Running a selection” on page 62.

The Cognos Integration Server activities are logged in the Integration Server logging database. You canview this log information in the Integration Server log viewer. You can use the log viewer to filter databased on date, log type, selection, and process. Information in the log viewer can be exported to a textfile. For more information, see “The Log Viewer” on page 88.

Integration Server Start menu items

The following menu items are available in the Windows Start menu in the IBM Cognos Integration Serverprograms folder as part of the Cognos Integration Server:Command Line Utility

Starts the Cognos Integration Server Command Line Utility.

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

Database ToolYou can use the database tool to initialize a new Cognos Integration Server database or to upgrade anexisting one. You can also use the database tool to switch between different databases.

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

IBM Cognos Integration Server 10.2.1Starts the Integration Server Manager.

IBM Cognos Integration Server fundamentals 7

Starting the Integration Server ManagerYou can use the IBM Cognos Integration Server Manager to work from the Integration Server navigationtree.

Before you begin

If you plan to extract data or metadata from SAP BW, the Cognos Integration Server requires the SAPClient libraries to be installed on the same computer as the Cognos Integration Server. For information onhow to obtain and install the SAP Client libraries, see the topic Installing the SAP Libraries for use with IBMCognos Integration Server in the topic IBM Cognos Installation Server Installation Guide .

If you plan to extract data or metadata from Oracle Essbase or from Oracle Hyperion Planning, the CognosIntegration Server requires an Oracle Essbase client to be installed on the same computer as the CognosIntegration Server. For Essbase version 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.xfolder. If the Oracle Essbase client folders cannot be located, a dialog is displayed asking if you plan toextract data or metadata from Oracle Essbase or Oracle Planning. Click OK and browse to the OracleEssbase client folder location and the Oracle RDBMS library folder location (for Oracle 11.1.2.0 or greateronly).

If you copied the Oracle Essbase runtime client files from another computer instead of installing OracleEssbase client, make sure that the files are stored in a folder structure similar to the following folderstructure:

\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 theOracle 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 for storing configuration parameters afterits initial installation. It will attempt to use the previously used database after an upgrade or re-installation. If a previous incompatible configuration of the Integration Server database is detected, adialog is displayed that prompts you to configure the Integration Server database. Click OK to open theIntegration Server database tool and upgrade the previous database.

Use the Integration Server database tool to change the Integration Server database to an existingIntegration Server database. For more information, see “The Integration Server Database Tool” on page11.

Procedure

From the Start menu, start the Integration Server Manager or on the desktop double-click the IBM CognosIntegration Server icon.

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

Use the Integration Server Options to set Selection Manager Options, to set target database table andcolumn mappings, and to configure member name mappings.


Setting Selection Manager optionsYou can use the Integration Server options to specify global configuration parameters.

About this task

This list describes the Selection Manager options:Data Extraction Auditing

• Creates an audit table with the name of the fact table and the following suffix: _AUDIT• The audit table is updated with a record that indicates the date and time of the run with each data

extraction run. An audit ID is added to the fact table to correspond to a record in the audit table.• To save a binary copy of the selection and settings to the audit table, click Save Selection Instance

with Audit Data.• For more information, see “Data extraction audit” on page 6.

Bulk Copy

• Enables bulk copy for HFM and Essbase Type II and IV data extractions. Insertions into the targetfact table use bulk copy instead of standard insert statements.

• Use this option to improve performance over the standard insert statements.

Essbase Extractor Messaging Port

• Sets the port number that is used by the Essbase Data Extractor for sending messages to theCognos Integration Server. The Essbase Data Extractor communicates with the Integration Serverby using TCP, which requires a specified port number.

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

the Essbase Data Extractor and Integration Server.

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

Procedure

1. From the Integration Server Manager window, click Tools > Options.2. Specify the options that you want.

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

About this task

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

The feature substitutes a character string that is found in the initial name with another character string. Avalue pair consists of an initial value and a replacement value. If more than one value pair is specified fora connection type, the result of the first string substitution is used as input to the next substitution frombeginning to end of the mapping table.

You can enter Space and TAB characters as part of the initial value or replacement value strings as'SPACE' or '\s' and 'TAB' or '\t', without the single quotation marks. If the initial value string is left empty, aspace character is assumed. You can enter space and tab characters as part of the initial value orreplacement value strings. 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 Integration Server restores thebuilt-in mappings after a restart if they are deleted. Set the replacement value to the initial value todisable a built-in mapping.

Attention: The character string substitution is case-sensitive.

Procedure

1. From the Integration Server Manager window, click Tools > Options.2. Click the Table and Column Name Mapping tab.3. Specify a replacement value for the initial value.

Mapping member namesUse the Member Name Mapping to map the names of source members to target member names.

About this task

You can use the Member Name Mapping tab to add or delete rows in the Mappings table and MappingDetails table.

Mappings - Name is the name of a set of maps. Description is an optional description of the mappings. InUse shows whether the mapping is used by any selection.

Mapping Details - One or more member name maps. Dimension Name is the name of the dimension themember to be mapped belongs to. For SAP BW member name mapping, the Dimension Name is the nameof the Characteristic. Initial Value is the original name of the source member. Replacement Value is thenew member name.

Mappings replace member names or part of a member name according to the Initial Value column withthe Replacement Value column. Member Name Mapping applies for each characteristic or Key Figure,allowing you to specify a replacement value for a member in a characteristic and a different replacementvalue for the same member in another characteristic.

Procedure

1. From the Integration Server Manager window, click Tools > Options.2. Click the Member Name Mapping tab.3. Configure the desired mappings.


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

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

Before you begin

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

Procedure

1. From the Integration Server Manager window, click 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:

• If Windows authentication is used to authenticate the connection to the SQL Server, select the UseSQL Server Trusted Connection check box.

• If SQL Server authentication is used, clear the Use SQL Server Trusted Connection check box andtype the user name and password in the User Name and Password text boxes.

Attention: To save the password with the configuration file, select the Save Passwordcheck box. If the Save Password check box is cleared, a password is prompted for eachtime Cognos Integration Server is run.

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

Before you begin

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

Procedure

1. From the Integration Server Manager window, click Tools > Integration Server 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 Save Password checkbox. If the Save Password check box is cleared, a password is prompted for each timeIntegration Server is run.


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

Procedure

1. From the Integration Server Manager window, click Tools > Integration Server 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 SQLite database or type in a new name to create a newSQLite database.

4. Click Test to test the connection. You must test the connection before you can use the database.5. Do one of the following steps, depending on the information given in the Test Integration Server

Database Connection window:

• If the database is up-to-date, click OK.• If the database is not initialized, click OK, then click Initialize in the database tool.• If the database is an older version, click OK, then click Upgrade in the database tool.

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

Procedure

1. From the Integration Server Manager window, click Tools > Integration Server 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 Save Password checkbox. If the Save Password check box is cleared, a password is prompted for each timeIntegration Server is run.

Installing the Essbase data extractor setup toolTo set up the Essbase data extractor, you use the data extractor setup tool to copy files to the Essbaseserver, update the Essbase server configuration files, and run a MaxL script that installs a custom-definedfunction (CDF) on the Essbase server.

Before you begin

To use Essbase Extraction Type I or Type III to extract data from a block storage option (BSO) cube, youmust install a CDF on the Essbase server. The CDF .jar file and accompanying files are referred to as theEssbase data extractor. For more information, see “Data extraction options” on page 34.

Procedure

1. 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 theEssbase server.

3. if the Essbase Server folder is valid and reachable from the Cognos Integration Server, the setup toolcompletes the name in Essbase Server.If you install the Essbase data extractor on an Essbase server that is not reachable, make sure that theEssbase server is the name of the Essbase server on which you are installing the Essbase dataextractor.

4. In Administrative User and Administrator Password, type the user name and password of anEssbase administrative user.

5. Click Setup to start installing the Essbase data extractor. After the setup is complete, you areinstructed on how to proceed.

• Essbase server on the same server as the Cognos Integration Server - after the setup completes,click OK, then click Register to register the CDF with Essbase.

• Essbase server installed on a different server - after the setup completes, click OK to viewinstructions for completing setup of the Essbase data extractor.

The last part of the setup of the Essbase data extractor is registering the CDF with Essbase.Instructions on the registration process are in the PostExtractorSetupSteps.txt file.

• Essbase server installed on a UNIX server - when you click Setup, a message displays asking if youwant to use the Essbase folder, even though the folder does not appear to be valid. Click Yes.

After the setup is complete, Click OK to view instructions for completing setup of the Essbase dataextractor.

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 data extractor, and is requiredfor the extractor to run properly. The properties are commented out by default by preceding each propertyline with a number sign (#).

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

Attention: Do not make any changes to the CIS.properties file unless you instructed to do soby IBM support personnel.

Procedure

1. 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. Essbase Data Extractor local logging is disabled bydefault. Remove the number sign (#) in front of the property to turn on logging of Essbase dataextractor log messages 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 setup tool.

About this task

These steps assume that the Integration Server is installed in the C:\Program Files\IBM\cognos\icis\ folder.

Procedure

1. Create the udf folder on the Essbase server.a) Open the Essbase server folder on the Essbase server computer.

For Essbase version 11.1.2.x, the server folder default is the following location: C:\Oracle\Middleware\EPMSystem11R1\products\Essbase\EssbaseServer. Do not use theC:\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\IBM\cognos\icis\EssbaseExtractor folder. This is thesource folder.

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

c) Copy all files in the source folder to the target folder. Stop the Essbase server if the file copy failsand 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.6to db2jcc.jar, rename the file ojdbc.6 to ojdbc.jar, and rename the file sqljdbc.6 tosqljdbc.jar. If Essbase is using a Java version of 1.5, rename the file db2jcc.5 todb2jcc.jar, rename the file ojdbc.5 to ojdbc.jar, and rename the file sqljdbc.5 tosqljdbc.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 the essbase.cfg file with atext editor and locating the line beginning with 'JvmModuleLocation'.

Note: For UNIX based Essbase servers, use FTP to transfer the files from the source folder to thetarget folder. Make sure the FTP mode is set to binary.

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 renamefails and start it again after the file rename.

4. Create the Essbase Data Extractor registration MaxL script RegisterEssbaseExtractor.msh.

• If the Essbase server is installed on a computer that runs the Windows operating system do thefollowing task:

– Open the RegisterEssbaseExtractor.msh file with a text file editor. The file is in the java\udf folder in the Essbase server folder.

• If the Essbase server is installed on a computer that runs the UNIX operating system do thefollowing task:

– Open the RegisterEssbaseExtractor_UNIX.msh file with a text file editor such as vi. Thefile is in the java\udf folder in the Essbase server folder


– Change the [Administrator ID], [Password for your system], and [EssbaseServer] in the login lineto the Essbase server name and name and password for the administrative user of your Essbaseserver. The login line typically looks like

login 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 serveris running on a Windows operating system:a) Locate the C:\Program Files\IBM\cognos\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 Essbase server is running on a 64-bit computer, copy thesqljdbc_auth.x64 file in the 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 folder in the Essbase serverfolder.

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 filea) Open the essbase.cfg file with a text file editor. The file is in the bin folder in 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.

• If the Essbase server is installed on a computer that runs the Windows operating system do thefollowing task:

– Run the RegisterEssbaseExtractor.bat batch file on the Essbase server computer. The fileis in the java\udf folder in the Essbase server folder.

• If the Essbase server is installed on a computer that runs the UNIX operating system do thefollowing task:

– For Essbase versions 11.1.2 and up, on the Essbase server computer, run the followingcommand: startMaxl.sh RegisterEssbaseExtractor_UNIX.msh. You can findstartMaxl.sh in the bin folder 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 followingcommand: essmsh RegisterEssbaseExtractor_UNIX. msh.

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


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

Procedure

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

Configuration file optionsYou can use an ASCII text file editor to open and edit the configuration files located in the IBM CognosIntegration Server install directory.

Use the following files to configure the Integration Server:ICIS.exe.config

Set options for the Integration Server Manager.ICISCMD.exe.config

Set options for the Integration Server Command Line Utility.Ibm.Cognos.IntegrationServer.SatelliteService.exe.config

Set options for the Satellite Server Service.

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

Audit table persistenceYou can edit the audit table persistence parameter.

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

Channel registration for Cognos Integration Server satellite serversSatellite server channel registration options must be set on both the client side and the server side.

Client-side Channel Registration

Client-side channel registration can be set for both TCP and for HTTP. Client-side channel registrationsettings typically do not need to be modified because the satellite server communication produces themautomatically.

TCPFaster than HTTP.Transmits binary data and cannot penetrate firewalls.Only the port number can be modified if necessary, as follows: <channel name="ClientSideTCP"ref="tcp" port="0">Typically, the port number is set to 0 for a client, so that data can be returned from the satellite serverto the Cognos Integration Server.

HTTPSlower 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 more information aboutsatellite server channels and leases, see the Satellite Server Installation Guide.

Server-Side Channel RegistrationSimilar to client-side channel registration, however, port ranges are computer-specific becausedifferent computers that use the same Integration Server database might be on different subnets. Inthis case, each computer requires a separate set of ports. Only the port numbers are modified in thechannel settings. The port numbers that are assigned to the satellite server must not be used by anyother application on the computer and 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" LeaseManagePollTime="10s" />

CultureThis key is used to override the region settings culture coming from the operating system.

The regional settings culture defines how numbers and dates are parsed. Use this key to override theregion settings culture coming from the operating system. The key can be added to either ICIS.exe.configfile or the Ibm.Cognos.IntegrationServer.SatelliteServer.exe.config file. Add this key to the ICIS.exe.configif the extraction is performed by the Integration Server, without the satellite. Add this key to theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file if the extraction is performed by the satellite.

The following is an example of the key:

<add key="Culture" value="en-US" />

Data value field length in star schema fact tablesYou can change the parameter that determines data value field length in star schema fact tables.

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 default value is 15.

The IBM Cognos Integration Server stores data values in relational fact tables as decimal values. Themaximum size of decimal values is determined by two entities; the number of digits in a number and thenumber of digits after the decimal point in a number. For example, the number of digits in 123.45 is 5 andthe number of digits after the decimal point is 2.

The number of digits to the right of the decimal point is set in Data Precision on the Data ExtractionOptions 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 data precision is 2, so the maximumdefault value is a number such as 123456789012345.67.

The values for FACTTableDataFieldLength plus data precision cannot exceed 38.


Display cultureThis key is used to override the display language culture coming from the operating system. Change thedisplay culture only if you want to change the display culture of Cognos Integration Server.

The key can be added to either ICIS.exe.config file or theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file. Add this key to the ICIS.exe.config if theextraction is performed by the Integration Server, without the satellite. Add this key to theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file if the extraction is performed by the satellite.

The following is an example of the key:

<add key="DisplayCulture" value="en-US" />

Fact table persistenceYou can edit the fact table persistence parameter.

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 dropped and created if they exist. Ifset to true, the temporary fact table is not dropped after a selection is run.

Fact table and column name quotation marksYou can change the parameters that determine if 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 that particular target databaseare enclosed in quotation marks.

QuoteColumnNames<add key="QuoteColumnNames" value="true" />If set to true, the columns of the following tables are enclosed in quotation marks: fact tables, HFMdimension tables, HFM process management tables, Planning units tables, Planning accountannotation tables, Planning cell text tables, Planning form annotations tables, and Planningsupporting details tables.If set to false, only column names that are reserved or invalid names for that particular targetdatabase are enclosed in quotation marks.

HFM custom dimensions name mappingYou edit HFM custom dimensions name mapping options.

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" /><add key="HFM_Custom2_Name" value="Custom2" /><add key="HFM_Custom3_Name" value="Custom3" /><add key="HFM_Custom4_Name" value="Custom4" />Before HFM version 11.1.2.2, IBM Cognos Integration Server used the names Custom1, Custom2,Custom3, and Custom4 for the four custom dimensions. Additionally, each custom dimension mighthave an alias name. To be compatible with earlier versions of the IBM Cognos Integration Server, set


the HFM_UseCustomDimensionAliases option to false to override the alias names. The names set bythe HFM_CustomX_Name parameters are used.The Cognos Integration Server uses the alias names, if any are configured, if theHFM_UseCustomDimensionAliases option is set to true.For HFM version 11.1.2.2 and greater, Cognos Integration Server always uses the names that areconfigured in the manage metadata table or custom dimension table for the custom dimensionnames.

HFM extract calculated dataUse this option to enable or disable the extraction of calculated data from HFM.

By default, the HFM_ExtractCalculatedData option is set to true. The key can be changed by editing theICIS.exe.config file or the Ibm.Cognos.IntegrationServer.SatelliteServer.exe.config file. Edit theICIS.exe.config if the extraction is performed by the Integration Server, without the satellite. Edit theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file if the extraction is performed by the satellite.

To edit the HFM_ExtractCalculatedData option, edit the following key:

<add key="HFM_ExtractCalculatedData" value="<true/false>"/>

HFM extract derived dataUse this option to enable or disable the extraction of derived data from HFM.

The key can be changed by editing the ICIS.exe.config file or theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file. Edit the ICIS.exe.config if the extraction isperformed by the Integration Server, without the satellite. Edit theIbm.Cognos.IntegrationServer.SatelliteServer.exe.config file if the extraction is performed by the satellite.

To edit the HFM_ExtractDerivedData option, edit the following key:

<add key="HFM_ExtractDerivedData" value="<true/false>"/>

HFM clusters with multiple nodesYou may have to configure the HFM clusters with multiple nodes options if you want to extract data fromHFM clusters with multiple nodes.

Edit the following options in the configuration file of each Satellite Server:

<add key="HFM_EPM_FILE_TRANSFER_DATA_FOLDER" value="<server working folder>" />Data extraction from HFM is a two-step process:

1. HFM extracts data to a compressed temporary file in the server working folder.2. The Cognos Integration Server decompresses the file, moves the data to its final destination, and

deletes the temporary file.

The temporary file may be located on any one of the HFM servers in the cluster. In order for CognosIntegration Server to be able to find the file on any of the clusters you may need to share the serverworking folders of each HFM server in the cluster.The server working folder may be similar to this: "C:\Oracle\Middleware\user_projects\epmsystem\products\FinancialManagement\Server Working Folder\"

Set the server working folders network as shared folders. Provide the shared folders with read/writeaccess for the user account that the Satellite Servers are running under.

Set the HFM_EPM_FILE_TRANSFER_DATA_FOLDER configuration key to contain one or more networkshared folders separated by a semicolon.

<add key="HFM_EPM_FILE_TRANSFER_DATA_TEMP_FOLDER" value="<temporary folder>" />The IBM Cognos Integration Server will search for the temporary file in the order specified. Thefolders are searched in addition to the local server working folder, which is located on the samemachine as the Satellite Server.


Note: By default, the temporary file is decompressed in the folder where it is located. If the temporaryfile is located on a shared folder it will be decompressed there, which is very inefficient. It isrecommended to set this configuration key to a folder local to the Satellite Server.

If you are using HFM 11.1.2.4 or higher, an alternative to setting theHFM_EPM_FILE_TRANSFER_DATA_FOLDER and the HFM_EPM_FILE_TRANSFER_DATA_FOLDER youmay choose to connect to a specific HFM server in the cluster and have the data extraction anddecompression take place on that server. Instead of specifying the cluster name in the HFMconnection, specify the cluster name and the HFM server name separated by a backslash. Forexample: MyCluster\MyServer.

Large data valuesYou can edit the large data values parameter.

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 extraction methods data values cannotexceed 7.9 x 10^28 when you extract to an RDBMS target. To enable the extraction of larger datavalues, set the option to true, or extract to a flat file target.

Attention: Rounding errors can occur when this option is enabled and you extract to an RDBMStarget.

Maximum number of LINK argumentsYou can change the maximum number of LINK arguments parameter.

Change 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 the maximum of[50]

If you receive the error when you run a Type IV Essbase data extraction, set the value to 50.

Password persistenceYou can edit the password persistence parameter.

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 to the configuration database.You are prompted for the user name and password each time a connection to the source or target isneeded.

Software license metricYou can edit the software license metric parameters.

Edit the following software license metric parameters:

MaxSLMTagFileByteSize<add key="MaxSLMTagFileByteSize" value="102400" />Sets the maximum size of an SLM tag file in bytes.


MaxSLMTagFiles<add key=" MaxSLMTagFiles" value="10" />Sets the maximum number of SLM tag files.

Table suffixesYou can edit the table suffix parameters.

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 of the audit table, the HFMprocess management table, the Planning account annotations table, the Planning unit annotationstable, the Planning form annotations 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 user group table, the Essbasefilter table, the Essbase Planning filter table, and the Essbase expanded filter table.

Attention: The length of the fact table prefix, the fact table name, and each suffix cannot exceed30 characters.

Use TM1 MDX extractorUse this option to enable or disable MDX data extraction.

The key can be changed from ICIS.exe.config file. By default this option is set to false. If it is set to true, itwill enable the MDX data extraction.

Note: MDX extraction does not require admin rights for TM1 extraction.

Use the following key to define MDX data extraction:

<add key="UseTM1MdxExtractor" value="<true/false>"/>

Use Unicode RDBMS table formatYou can change the parameters that force the IBM Cognos Integration Server to use the Unicode format.

Edit the following Unicode format parameters:

AlwaysUseUnicodeRDBMSTableFormatSAP<add key="AlwaysUseUnicodeRDBMSTableFormatSAP" value="true" />Set the value to true to force the IBM Cognos Integration Server to use the Unicode format of the SAPdimension and fact tables.


AlwaysUseUnicodeRDBMSTableFormatStarSchema<add key="AlwaysUseUnicodeRDBMSTableFormatStarSchema" value="true" />Set the value to true to force the IBM Cognos Integration Server to use the Unicode format of theCognos Integration Server Star schema dimension and fact tables.

AlwaysUseUnicodeRDBMSTableFormatEssbase<add key="AlwaysUseUnicodeRDBMSTableFormatEssbase" value="false" />Set the value to true to force the IBM Cognos Integration Server to use the Unicode format of theEssbase dimension and fact tables, regardless of the character 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 the Unicode format of the HFMdimension and fact tables.

Validate member selections before you run the command-line utilityYou can change the parameter that determines whether or not to validate member selections before thecommand-line utility is 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 selection against the actual databaseoutline before the selection is run. If one or more members are deleted from the outline, the run fails.The missing members are displayed in the command-line window and logged to the log file.

Attention: Setting this option to false might speed up running a selection. Do so only if you knowthat your Essbase outline is unchanged.

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 and targets in which extracteddata is stored.

Connections to the following data sources are supported:

• SAP Business Warehouse• Cognos TM1• Cognos Integration Server star schema• Oracle Essbase• Hyperion Planning• Hyperion Financial Management

Connections to the following data targets are supported:

• SAP BW DataStore Object (DSO)• SAP BW InfoCube• Cognos TM1• Microsoft SQL Server using a trusted connection• Microsoft SQL Server using SQL Server login• IBM DB2• Oracle• Text files


Creating a connectionConnections are paths between data sources from which data is extracted and targets in which extracteddata is stored. Each connection has its own unique connection ID.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation tree.2. From the toolbar, click New Source Connection or New Target Connection and select a source or

target connection.3. You can change the default connection details for your specific connection, such as Name and

Description, to make them more meaningful.

Appropriate parameters for the type of connection are displayed.4. Edit the connection parameters or select values from the drop-down lists.5. For Hyperion Finance Management (HFM) source connections, if a satellite server is used, check

Enabled for Satellite Server, click the Satellite Configuration tab and type the Server name or IPaddress. For more information, see “Enabling a Connection to use a satellite server” on page 23.

6. Click Test to test the connection.

For all connections except SQL Server using trusted connections and text file connections, if you leavethe user name or password blank, you are prompted for a user name and password when the CognosIntegration Server uses the connection.

7. Click OK to save your settings, or click Cancel to close the window 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 8010 for HTTP protocol.Check with the administrator that installed the satellite server to confirm the port numbers, if necessary.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 “Channel registration for CognosIntegration Server satellite servers” on page 16.

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

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 Show Status, then click Test to view the results in the statuswindow.

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

About this task

If the connection is in use, only parameters like User Name or Password can be edited.

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

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 connection that is no longerneeded, first delete the selection and then delete the connection. For information about viewing a list ofselections that use the connection, see “Viewing connection uses” on page 25.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation tree.2. In the Connection List window, select a connection.3. Click Delete.

Tip: To delete multiple connections, press Ctrl and click each connection, or press Shift and click toselect a range of connections.

Cloning a connectionYou can use cloning to make a copy of an existing connection.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 the exported file areencrypted.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 create a new connection from a previously exported connection file.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation tree.2. In the Connection List window, click Import or right-click on the Connection Manager node in the IBM

Cognos Integration Server navigation tree and select Import Connection.3. Select a previously exported connection and then click Open.4. Click OK to confirm that the exported connection file was successfully imported.

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 specific connection, and that it isbeing used as a source connection.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 .

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

To open the Selection Manager, click Selection Manager in the IBM Cognos Integration Server navigationtree.

These selection types are supported:

• TM1 selections• SAP BW selections• CIS and Generic Star Schema selections• Essbase selections• Planning selections• 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 target connections to be used bythe selection. For more information, see “The Connection Manager” on page 22.

Procedure

1. To open the Selection Manager, click Selection Manager in the IBM Cognos Integration Servernavigation tree.

2. From the New Selection menu, click the selection that you need.3. In Selection Name, type a meaningful name.

You can also provide a description.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.

Procedure

1. 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 Integration Server database is notphysically deleted. The selection record is flagged as deleted and can no longer be used by the CognosIntegration Server. However, the metadata of the selection can still be referenced for auditing purposes.

Procedure

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

Procedure

1. 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 for the selection to beimported must exist. For more information, see see “The Connection Manager” on page 22.

Procedure

1. 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 source and target connections.6. Click OK to import.

Exporting a selectionYou can export a selection to a file.

About this task

Selections are exported to files that have the extension .sas. Any passwords within the exported file areencrypted.

Procedure

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

Extraction optionsYou can set the metadata extraction options or the data extraction options of a selection.

Procedure

1. 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 Metadata Extraction Options tab to set options for meta data extraction, or click the Data

Extraction Options tab to set options for data extraction.

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

The following list describes the selection information options:

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 connection from the list of previouslyconfigured connections. The source outline of the application is automatically retrieved and displayedafter a source connection is selected. Click the Open the Source Connection icon beside the selectedconnection to view the connection parameters.

Target ConnectionThe target connection that is used by the selection. Click the Open the Target Connection icon besidethe selected connection to view the connection parameters.

Star schema optionsStar schema options are available for relational and text file targets.

Attention: For extraction from a Cognos Integration Server star schema that uses a DB2 RDBMSsource, you must create a USER TEMPORARY tablespace on the chosen DB2 source database.

SAP BW selection star schema optionsThis section describes the star schema options for SAP BW.Create Star Schema

This option is only available for RDBMS target connections. If selected, the IBM Cognos IntegrationServer creates the dimension (metadata) tables and the fact table before metadata and data isextracted. If the dimension (metadata) tables and the fact table exist, they are dropped and re-created. The dimension tables are re-created only if Extract Metadata is selected. The fact table isre-created only if Extract Data is selected.

FACT Table NameThe name of the fact table where data is extracted to. The name is prefixed with the star schemaprefix.

Star Schema PrefixA prefix that is given to all of the star schema tables that are created with this selection so thatmultiple star schemas can be extracted to the same database. A typical naming convention is a shortprefix followed by an underscore, for example ABC_.

FACT Table FormatThis option determines the layout of the fact table.

• If the Narrow format is selected, the fact table columns consist of one column for each dimensionplus one column for data and one column for the audit ID.

• If the Wide format is selected, the fact table consists of one column for each dimension except forthe wide dimension, columns for each wide dimension member that is selected as part of themember selection, and a column for the audit ID.

For SAP BW selections, the wide dimension is always the Key Figures dimension.

Attention: With wide format, it is possible to select a dimension column and a data columnwith the same name. For example, selecting the Year dimension in an HFM selection and the[Year] member of the Period dimension results in an error. This has the following solutions:

• Use narrow format.• Do not select the Year column in the fact table.• Do not select the [Year] member of the period dimension.• Extract data to a text file.• Rename the Year dimension column. For more information, see “Mapping target database

table and column names” on page 9.• Rename the selected [Year] member of the Period dimension using the Custom Name field in

the member selection.

The wide format can reduce the number of records that are stored in the target connection that isdetermined by the number of wide dimension members selected. For example, if Jan through Dec is


selected as the wide dimension members, the wide format produces one record for every 12 underthe narrow format.

FACT Table Member ValuesThis option determines the format of the dimension column values of the fact table. If set to DisplayNames, the values are the display names of the members. If set to Tech Names, the values are thetechnical names of the members.

Max. AttributesSets the maximum number of attributes in the dimensional tables.

Cognos TM1 selection star schema optionsThis section describes the star schema extraction options for Cognos TM1.

The following list describes the star schema extraction options for Cognos TM1 selections:

Create Star SchemaThis option is only available for RDBMS target connections. If selected, the IBM Cognos IntegrationServer creates the dimension (metadata) tables and the fact table before metadata and data isextracted. If the dimension (metadata) tables and the fact table exist, they are dropped and re-created. The dimension tables are re-created only if Extract Metadata is selected. The fact table isre-created only if Extract Data is selected.



Essbase and Planning selection star schema optionsThis section describes the star schema extraction options for Essbase and Planning.Create Star Schema

This option is only available for RDBMS target connections. If selected, the IBM Cognos IntegrationServer creates the dimension (metadata) tables and the fact table before metadata and data isextracted. If the tables exist, they are dropped and re-created. The dimension tables are re-createdonly if Extract Metadata is selected. The fact table is re-created only if Extract Data is selected.






For Essbase and Planning selections, the wide dimension is the spin dimension. For more informationabout spin dimensions, see “Essbase column selections” on page 49.

Attention: With wide format, it is possible to select a dimension column and a data columnwith the same name, even though this might result in an error. For example, selecting the Year


dimension in an HFM selection and the [Year] member of the Period dimension results in anerror. This has the following solutions:


table and column names” on page 9.

The wide format can reduce the number of records that are stored in the target connection that isdetermined by the number of wide dimension members selected. For example, if Jan through Dec isselected as the wide dimension members, the wide format produces one record for every 12 underthe narrow format.

FACT Table Member Values

This option determines the format of the dimension column values of the fact table. Member Namesand Member ID values are available for Essbase, Planning, HFM, and Star Schema selections.

If set to Member Names, the values are the names of the members. The dimension column values inthe fact table are text strings, which take up more hard disk space and are slower to query whenjoined with the dimension tables.

If set to Member ID, the values use an ID that references the ID of the member in the relateddimension table. The IDs are integers, which take up less space and have faster query times than textstrings.

Member ID is not valid when you use text file, TM1, or SAP targets.

Max. UDAsSets the maximum number of UDA columns in the Essbase dimension tables. For more information,see “Essbase dimension table” on page 110

Dimension Table LayoutThis option determines the format of the metadata tables.

• Parent-child

• Balanced Hierarchy I: you can use the translation table to specify a name for each dimension'sgeneration or level. These names are used as the respective dimension table's column names foreach generation or level.

• Balanced Hierarchy II: QlikView layout.

• Master Data Management• MDM Version: Master Data Manager version number for MDM metadata exports

For more information, see “Parent-child format” on page 106, “Generation format” on page 106,“Level format” on page 108, and “Master data management format” on page 109.

HFM star schema optionsThis section describes the star schema extraction options for HFM.Create Star Schema








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

Attention: With wide format, it is possible to select a dimension column and a data columnwith the same name, even though this might result in an error. For example, selecting the Yeardimension in an HFM selection and the [Year] member of the Period dimension results in anerror. This has the following solutions:




FACT Table Member Values

This option determines the format of the dimension column values of the fact table. Member Namesand Member ID values are available for Essbase, Planning, HFM, and Star Schema selections.



Member ID is not valid when you use text file, TM1, or SAP targets, or when extracting data from HFMversion 11.1.2.4.

Dimension Table LayoutThis option determines the format of the metadata tables.

• Parent-child

• Balanced Hierarchy I: you can use the translation table to specify a name for each dimension'sgeneration or level. These names are used as the respective dimension table's column names foreach generation or level.

• Balanced Hierarchy II: QlikView layout.

• Master Data Management• MDM Version: Master Data Manager version number for MDM metadata exports


For more information, see “Parent-child format” on page 106, “Generation format” on page 106,“Level format” on page 108, and “Master data management format” on page 109.

IBM Cognos Integration Server star schema optionsThis section describes the extraction options for Cognos Integration Server start schema selectionsCreate Star Schema







The wide dimension is the spin dimension. For more information about spin dimensions, see “Essbasecolumn selections” on page 49.

Attention: With wide format, it is possible to select a dimension column and a data columnwith the same name, even though this might result in an error. For example, selecting the Yeardimension in an HFM selection and the [Year] member of the Period dimension results in anerror. This has the following solutions:




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



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


Cube optionsCube options are available for selections that use a TM1 target connection.

The following list describes the cube options available:

Create CubeIf selected, the IBM Cognos Integration Server creates the dimensions and the cube in TM1. If thecube and dimensions exist, then they are deleted and recreated again. Other cubes that use theselected dimensions are also deleted.If not selected, the extracted metadata is merged with the existing dimensions in TM1 and the cubedata is overwritten.

Cube and Dimension PrefixA prefix that is given to the cube and dimensions that are created with this selection so that multiplestar schemas can be extracted to the same TM1 server.A typical naming convention is a short prefix followed by an underscore, for example ABC_.

Member Name FormatThis option determines the format of the names of the TM1 dimension members. The names caneither be SAP display names, technical names, or a combination.

Alias Name FormatThis option determines the format of the alias names of the TM1 dimension members. The names caneither be SAP display names, technical names, or a combination.

TM1 Architect IntegrationThe TM1 Architect Integration options allow for a tighter integration between the Cognos IntegrationServer’s data extraction capabilities and TM1 Architect’s data transformation capabilities.The options can be used whenever there is a need for further manipulating the extracted data beforeit is deposited into the TM1 cube and dimensions. With the options enabled, the extracted data isuploaded to the TM1 server as .csv files, and TI scripts are created on the TM1 server. The scriptscan act as a starting point for developing more complex TI scripts.

• Upload Data and Metadata As .CSV Files - If this option is checked, the dimensions metadata andcube data is uploaded to TM1 as .csv files. Any existing cube and dimensions are left unchangedand the Create Cube option is disabled. The dimensions metadata is uploaded only if ExtractMetadata is checked and the cube data is uploaded only if the Extract Data is checked. If the .csvfiles exist on the TM1 server they are overwritten.

• Add Selection Process Script - This option creates a TM1 process, which when started runs thecurrent selection. The name of the process is the name of the selection, prefixed by Start_. Theoption is only available if the integration server is installed on the same computer as TM1 server.

• Add Cube and Dimension Create Script - If this option is checked, a TM1 dimension creationprocess is created for each dimension selected if Extract Metadata is selected. A TM1 cubecreation process is created if Extract Data is checked.

Additionally, a chore that combines the processes is created. The processes use the uploaded .csvfiles as data sources. Running the processes creates the dimensions and the cube based on theselection. The processes are not modified by the Cognos Integration Server if they exist. This allowsthe user to modify the processes to suit their business needs without risking them beingoverwritten.

Metadata extraction optionsThe following list describes the metadata extraction options.Extract Metadata

Select this option to extract metadata to the respective dimension tables. For TM1, HFM, star schema,Essbase and Planning selections, metadata is extracted only for the dimensions that are selected inthe Essbase column selections.For SAP BW InfoCube and InfoQuery selections, metadata is extracted for the selected columns orTM1 dimensions. Extract metadata creates a dimension for each selected characteristic, attribute


and the key figures dimension; it creates one dimension for each row in the table found in theDimension Selections table.Columns marked as Ignore will not be exported.

Note: Columns of the target table and the source table should have similar data types.

Balanced Hierarchy IApplies to only Essbase, Planning, and HFM selections with Dimension Table Layout set to BalancedHierarchy I. Select either Generation Format, in which metadata columns are ordered in descendingorder, or Level Format, in which metadata columns are ordered in ascending order. The system findsthe maximum level of the drill path and then adds the required number of columns to support holdingall of the levels. Where there are null values, for example where a level does not exist for any givendrill path, 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 the EssbaseUser table.

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

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

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

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

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

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


Extract Planning FiltersApplies to only Essbase and Planning selections.Select this option to extract Planning filters data and generate the PlanningFilter table.


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

The following topics describe the data extraction options for SAP BW, TM1, Essbase and Planning, HFM,and star schema selections.

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

The following list describes the data extraction options for SAP BW selections:Extract Data

Check this option to extract data to the fact table.Data Precision

Specifies the number of decimal places the extracted data is rounded to.Record Commit

Specifies the number of extracted data records that are held in memory before they are committed tothe target connection.

For example, if the target connection is SQL Server and the record commit level is 1000, records arewritten to the SQL Server in blocks of 1000.

Attention: This option helps data extraction performance. A higher record commit number canboost the performance by lowering the number of database accesses. However, a high record


commit requires more memory for intermediate storage on the server where the IBM CognosIntegration Server is located.

Load TypeSpecifies how data is written to the target connection:

• Merge: The extracted data records are merged with existing records. This option is not supported fortext file target connections.

• Refresh: All data records in the target connection are deleted and replaced with the data recordsfrom the selection data.

• Append: Data records from the selection are appended to the target data source. Existing data isnot affected.

Member Name MappingSelect a member name mapping to map names of one or more source characteristics to differentnames in the target dimensions. For more information about how to create a member name mapping,see “Mapping member names” on page 10.

Attention: Member name mapping is applied to both data and metadata extractions. Membernames in metadata tables are mapped even if Data Extraction is not checked.

Member Technical Name MappingSelect a member name mapping to map technical names of one or more source characteristics todifferent names in the target dimensions. For more information about how to create a member namemapping, see “Mapping member names” on page 10.

Attention: Technical member name mapping is applied to both data and metadata extractions.Technical member names in metadata tables are mapped even if Data Extraction is notchecked.

Check Member Selection CompatibilityIt is possible to select members that yield no data in combination but do yield data if the members areselected individually. If this is option is checked, a warning is logged when a member selectioncompatibility problem is detected.

SuppressionSpecifies options for suppressing intersection points:

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

• Missing: All intersection points that have no data are not extracted. This option is not available forRAW InfoCube selection extraction types.

Extraction type (InfoCube Selections)Select this option to specify the extraction type.

• MDX:

– This extraction type uses MDX queries to extract data from the SAP BW server. See Buffer size.– Allows attributes to be extracted as dimensions.– Can perform both Zeros and Missing suppression.– Can be multi-threaded.– Limit of 1,000,000 records extracted at a time.– Chunks data if records exceed 1,000,000. Size of chunks is defined by Buffer size.

• RAW:

– This setting extracts data from SAP by using the RSDRI_INFOPROV_READ_RFC BAPI.– This method is not as flexible as MDX, but is faster.– This method does not work with attributes selected as dimensions, and it does not work with the

All member selected for default characteristics.


– The BAPI always returns data for existing intersections, so no missing data can be returned usingRAW. This is why the Missing suppression option is disabled for this extraction type.

Extraction type (InfoQuery Selections)Select this option to specify the extraction type. The Cognos Integration Server extracts data fromSAP BW InfoQueries in chunks by using MDX queries.

• VARIABLE: The initial chunk of data that is requested from the SAP BW server is the combination ofall selected members. If that chunk is too large for the SAP BW server to handle, the CognosIntegration Server splits up the initial chunk into smaller chunks. See Buffer size.

• FIXED: With this extraction type the total number of intersections to extract is split into chunks of afixed size. See Buffer size.

Buffer sizeSAP BW servers can only process MDX queries of a certain maximum size. If the selected set ofmembers is larger than that size, the Cognos Integration Server splits the queries into smaller chunksand combines the result. Depending on the extraction type, the buffer size can either be variablefractions of chunk sizes or a fixed chunk size. If fractions are used, Cognos Integration Server keepssplitting the chunks into fractions until the chunk size is small enough for the SAP BW server tohandle.

Extraction threadsCognos Integration Server extracts data from the SAP BW server in chunks when it is using MDXqueries. Select this option to specify the maximum number of data chunk extractions that are run inparallel. A higher number puts a higher load on the SAP BW server during a data extraction. Settingthe extraction threads to a value of 1 loads the SAP BW server the least, but can lengthen the dataextraction time. Set the option to Auto to use one thread per processor on the computer that CognosIntegration Server is running on.

SAP target extraction optionsYou can specify the SAP target extraction options.

SAP DSO and SAP InfoCube targets can be used with any selection, but not all extraction options areavailable for them. Unavailable options are disabled or hidden.

The following list describes the data extraction options for SAP targets:

Fact Table FormatThis option is disabled because only wide format is available for DSO and InfoCube targets as SAPaccepts data in this format only.

Extract MetadataThis option is disabled because DSO and InfoCube targets can only load data into SAP. They do notcreate DSOs, InfoCubes, or the Characteristics or Key figures they contain. However, the datawriteback interface that SAP exposes adds members to characteristics if these members appear inthe data, but are not found in the characteristics.

Load TypeFor DSO targets, care must be used when using Append. A DSO’s key fields must have unique valuecombinations because they represent the unique key of the DSO in SAP. Appending data to a DSO willfail if this condition is not met. When using Append with DSO targets, make sure to select data forwhich the key field characteristics do not contain values already existing in the SAP DSO.

For InfoCube targets, using the Merge load type can greatly impact performance.

Custom NameThe columns in the data written to SAP must have the same names as the technical names of thecolumns in the InfoCube or DSO in SAP. The custom name for dimensions and key dimensionmembers can be used to make sure each column in the source database will be mapped to thedesired column technical name in the InfoCube or DSO.


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

The following list describes the data extraction options for Cognos TM1 selections:Extract Data





Attention: This option helps data extraction performance. A higher record commit number canboost the performance by lowering the number of database accesses. However, a high recordcommit requires more memory for intermediate storage on the server where the IBM CognosIntegration Server is located.







Check Member Selection CompatibilityIt is possible to select members that yield no data in combination but do yield data if the members areselected individually. If this is option is checked, a warning is logged when a member selectioncompatibility problem is detected.



• Missing: All intersection points that have no data are not extracted. This option is not available forRAW InfoCube selection extraction types.

Extraction typeSelect this option to specify the extraction type.

• MDX: This is the only extraction type supported.

Extraction threadsSelect this option to specify the maximum number of data chunk extractions that are run in parallel.Only one thread is supported.


Essbase and Planning data extraction optionsYou can specify how data is extracted in an Essbase and Planning selection.

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

Extract DataCheck this option to extract data to the fact table.

Data PrecisionSpecifies the number of decimal places the extracted data is rounded to.

Record CommitSpecifies the number of extracted data records that are held in memory before they are committed tothe target connection.







Use AliasSpecifies that member aliases are extracted to the target connection fact table rather than themember names. This option has no effect if the FACT Table Member Values option is set to MemberID.

If you use extraction type III and a text file target, the exported dimension values are member names.

This option is not available for TM1 target connections.



• Missing: All intersection points that are #Missing or NULL are not extracted.


Extraction typeSelect this option to specify the extraction type. For more information, see “Essbase extraction types”on page 50.

• Type I: This extraction type offers the highest flexibility and feature set.• Type II: An alternative extraction type that, in some cases, yields higher performance.• Type III: A high-speed extraction type. This option is only available when connected to a 9.3.x

Essbase server or more recent.• 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 ASO application. Use any extractiontype for extracting data from a BSO application.

Type I and III require that the Essbase data extractor is installed. For more information, see“Installing the Essbase data extractor setup tool” on page 12.

Type I and III are not available for Cognos TM1 targets.

Buffer sizeSelect this option to specify the size of the internal buffer. This setting is typically left at the default ofAuto.

Setting the buffer size too low can result in longer extraction times. Setting the buffer size too high canresult in an unresponsive Essbase server.

If the buffer size is set to Auto, the Cognos Integration Server calculates an appropriate buffer sizethat is based on the performance of the computer that the Cognos Integration Server is running on,the members that are selected, and the performance of the Essbase server. The actual buffer size thatthe Cognos Integration Server uses is recorded in the SIS log after each data extraction. That buffersize is typically used as a starting point if it becomes necessary to change the default buffer size.

For large and sparse databases, it might be advantageous to set the buffer size to a larger value thanthe one chosen by the Cognos Integration Server when you use type IV extraction.

Only available for Essbase extraction type II and type IV.

Extraction threadsSelect this option to specify the maximum number of extraction threads that are used during anextraction. This setting is typically left at its default of Auto. A higher number puts a higher load on theEssbase server during a data extraction. Setting the extraction threads to 1 loads the Essbase serverthe least, but can lengthen the data extraction time.


Lock database during extractionSelect this option to prevent updates to the Essbase database during extraction.


Sparse DiscoveryEnables the Essbase sparse discovery. Sparse discovery can reduce the extraction time for sparselypopulated databases. Sparse discovery reduces extractions of intersections with missing data and istherefore not available if Suppression is set to not suppress missing data.

Note: The selected part of the Essbase outline must be aggregated before you run a data extractionwith Use Sparse Discovery enabled.

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

Available for Essbase extraction types II and IV.

Level 0 OptimizationOptimizes the Sparse Discovery for selections with member functions 'Select Members from herebased on Level' and level = 0 (zero).

Available when Use Sparse Discovery is enabled.

Implicit Share OverrideSettings:

• OFF• PARENT-CHILD• UDA• GENMBRS• LEVMBRS


Essbase implicitly removes parent members that have only a single child member. In the followingoutline, data that is extracted from products 500, 500-10, 500-10-10 show up in the output as ifcoming from 500-10-10-10. The background text is deliberately blurred.

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

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

This option applies only to Essbase extraction type I.

Stored Members OnlySpecifies that dynamic members are left out of the extraction.

Available for Essbase extraction types I and III.

Intelligent ExtractSpecifies that only data that is changed since the last extraction is extracted.

Selecting this option makes Essbase examine the Clean or Dirty flags on Essbase blocks and extractonly 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 the extraction. Available for Essbaseextraction types I and III.

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

Set Data as CleanApplies to Essbase and Planning. Specifies that the status of the Essbase data blocks is set to Cleanafter the extraction.

Available for Essbase extraction types I and III.

Custom Data Value FilterLimits the Essbase selection output that is based on standard Essbase IF condition syntax. Customdata value filtering is similar to the Member Selection Custom Calculation function, but at theselection level rather than at the member selection level.

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

[[DataValue]]<1000

To return data between 200 and 1000, you type:

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

Only available for Essbase extraction type I and Narrow fact table format.

Custom Scope ControlProvides an alternative way of entering member selection criteria in addition to the function providedby the Selection Manager.


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

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

Not available for Essbase extraction type II and type IV.

HFM data extraction optionsYou can specify how data is extracted in an HFM selection.

The following list describes the data extraction options for HFM selections:

Extract DataCheck this option to extract data to the fact table.

Data PrecisionSpecifies the number of decimal places the extracted data is rounded to.

Record CommitSpecifies the number of extracted data records that are held in memory before they are committed tothe target connection.







Include Cell Status in FACT TableIncludes cell status in the fact table. This option is not available for Cognos TM1 targets.

Attention: Selecting this option lengthens the data extraction time.



• Shared Entity Members: Suppresses the extraction of duplicate Entity Member data intersectionpoints from HFM where the Entity name and Parent name are the same. The same Entity name withtwo different parents is still extracted.

• Dynamic Accounts Members: No intersection point where the Accounts member is dynamic isextracted. Selecting this option can improve the extraction performance.

• Relative Parent Entity Members: Suppresses the extraction of data from intersection points fromHFM where the Entity member's parent is not the default entity parent.

Extract Process Management DataSpecifies that process management data is extracted from members that are selected in the MemberSelections window.


This option is not available for Cognos TM1 targets.

Extract Journal EntriesSpecifies that journal entries are extracted from members that are selected in the Member Selectionswindow, or that all journal entries for the HFM application are extracted.


Extract Cell Line Item DetailsSpecifies that cell line item details are extracted from members that are selected in the MemberSelections window, or all cell line item details for the HFM application are extracted.


Extract Cell TextSpecifies that cell text is extracted from members that are selected in the Member Selectionswindow or all Cell Text for the HFM application is extracted.


Extract Cell HistorySpecifies that cell history is extracted from members that are selected in the Member Selectionswindow or all cell history for the HFM application.



Star schema data extractionYou can extract data in a star schema and pass the data to the target.

Data in a star schema is extracted using multiple SQL statements, which extract data in chunks and thenpasses the data to the target. The following outlines the properties of the star schema data extraction.

Columns data typesDimension data column types are propagated from the source dimension tables to the target. You canextract both numeric and string types from fact tables with data columns.

Member namingFrom the source fact table to the target fact table, you may export member names, member IDs,aliases (from the marked “Alias” columns), custom names and member name mappings.The member references in the fact table are identified based on what the user marked with “Is FactKey” in the Dimension tables configuration tab in the Star Schema Connection. Marking the wrongcolumn will lead to intersection and data skipping during extraction.

Column name mappingIf the source fact table is in wide format and a spin dimension table is specified, the wide members(column names) will be present in that table. If these settings are not met, they will not be identifiedand will be skipped during data extraction.

AggregationAggregation is done when duplicate intersections appear in the target fact table (e.g. if the userselects less dimensions than the ones in the original fact table). The corresponding data values aresummed up. This occurs only if all selected data columns for export are of numeric type.Aggregation can be of two types: vertical and horizontal

• Vertical aggregation (V) represents the normal case, i.e. summing up the values on a single datacolumn.

• Horizontal aggregation (H) means that the summing up is done across all data columns too (e.g.SUM(DataColumn1) + SUM(DataColumn2) + …)


SuppressionDuring data extraction, numeric data columns can be suppressed if they contain a zero value or aremissing. Data columns of non-numeric data types can be suppressed if they are missing values.If the extracted row contains both numeric and string data, and Suppress zeros and missing ischecked, the row is suppressed if the data is represented by a zero and a NULL or empty string value.Suppressible values in the case of multiple table transformations will result in the values beingsuppressed across all transformations.

Table formats and transformationFor a transformation:

• The source fact table may be in narrow (single Measures column) or wide format (multiple Measurescolumns).

• Target fact table formats can be narrow or wide.

Note: If the source fact table is in narrow format (and no spin dimension table specified) and thetargeted format is also narrow, then the narrow data column name should be propagated to the target

The table below describes all possible transformations between source and target formats, related toaggregation and actual transformations:

Table 1: Table formats and transformation

Needs transformation Aggregation Target data columnstype

Narrow to narrow No Vertical Source narrow columntype

Narrow to wide Yes Vertical Source narrow columntype

Wide to narrow (withsource spin checked forexport)

Yes Vertical Common data type ofselected source widecolumns

Wide to narrow(without source spinchecked for export)

No Vertical and Horizontal Common data type ofselected source widecolumns

Wide to wide (samespin for source andtarget)

No Vertical Source wide columnstype (propagated foreach)

Wide to wide (differentspins, with source spinchecked for export)

Yes, twice Vertical Common data type ofselected source widecolumns

Wide to wide (differentspins, without sourcespin checked forexport)

Yes, once Vertical and Horizontal Common data type ofselected source widecolumns

• Aggregation column refers only to numeric data columns case• Transformation between formats represents an additional (and somewhat costly) step during the

extraction process• “Spin” means the spin / wide dimension for the source or target

Error messagesYou may experience an error message if any of the following are true:

• The fact table cannot be found.


• The dimension table cannot be found.• More than one hierarchy root node is found for a dimension when building the outline.• When exporting from a wide format to a narrow format.• When exporting from a wide format to a wide format with a different spin.• When exporting from a wide format to a wide format with data columns containing different data

types.

Star schema data extraction optionsYou can specify options for how data is extracted in a star schema selection.

Data in a star schema is extracted using multiple SQL statements, which extract data in chunks and thenpasses the data to the target.

Columns data typesNumeric and string types can be extracted from fact tables with data columns.Data column types are propagated from the source to the target.Target dimension column data types are propagated from the source dimension tables.

Member namingThe source fact table may contain member IDs, member names, aliases, custom names/membername mappings; the member references in the fact table are identified based on what the usermarked with “Is Fact Key” in the Dimension tables configuration tab in the Star Schema Connection.Marking the wrong column will lead to intersection and data skipping during extraction.Members in the target fact table may be exported with: member names, member IDs, aliases (fromthe marked “Alias” columns), custom names and member name mappings.

Column name mappingIf the source fact table is in wide format and a spin dimension table is specified, the wide members(column names) will be present in that table. If these settings are not met, they will not be identifiedand will be skipped during data extraction.

AggregationHappens only if all selected data columns for export are of numeric type.Occurs when duplicate intersections appear in the target fact table (e.g. if the user selects lessdimensions than the ones in the original fact table) – the corresponding data values need to besummed up.Is done on RDBMS side, using SUM aggregation function on the data columns and a GROUP BY clauseat the end of the extraction SQL statement.Can be of two types: vertical and horizontal

• Vertical aggregation (V) represents the normal case, i.e. summing up the values on a single datacolumn

• Horizontal aggregation (H) means that the sum-up is done across all data columns too(SUM(DataColumn1) + SUM(DataColumn2) + …)

SuppressionValues on numeric data columns can be suppressed if they are zero or missingValues on data columns of other data types can be suppressed if they are missing onlyIf the extracted row contains, for example, one numeric and one string data, and “Suppress zeros andmissing” is checked, then the row should be suppressed if the data is represented by a zero and aNULL or empty string value.If more rows suitable for suppression result during table transformations from one format to another,then the values should be suppressed across all transformations, so that they are not propagated tothe resulting fact table


Table formats and transformationThe source fact table may be in narrow (single Measures column) or wide format (multiple Measurescolumns)Target fact table formats can be narrow or wideIf the source fact table is in Narrow format (and no spin dimension table specified) and the targetedformat is also narrow, then the narrow data column name should be propagated to the targetThe table below describes all possible transformations between source and target formats, related toaggregation and actual transformations in code

• Aggregation column refers only to numeric data columns case• Transformation between formats represents an additional (and somewhat costly) step during the

extraction process• “Spin” means the spin / wide dimension for the source or target

Table 2: Table formats and transformation

Needs transformation Aggregation Target data columnstype

Narrow to Narrow No V Source narrow columntype

Narrow to Wide Yes V Source narrow columntype

Wide to Narrow withsource spin checked forexport

Yes V Common data type ofselected source widecolumns

Wide to Narrow withoutsource spin checked forexport

No V and H Common data type ofselected source widecolumns

Wide to Wide, samespin for source andtarget

No V Source wide columnstype (propagated foreach)

Wide to Wide, differentspins, with source spinchecked for export

Yes, twice V Common data type ofselected source widecolumns

Wide to Wide, differentspins, without sourcespin checked for export

Yes, once V and H Common data type ofselected source widecolumns

The following list describes the data extraction options for IBM Cognos Integration Server Star schemaselections:Extract Data





Attention: This option helps data extraction performance. A higher record commit number canboost the performance by lowering the number of database accesses. However, a high record


commit requires more memory for intermediate storage on the server where the IBM CognosIntegration Server is located.





Use AliasSpecifies that member aliases are extracted to the target connection fact table rather than themember names.

This option is not available for TM1 target connections.



• Missing: All intersection points that have no data are not extracted.



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.

Essbase selection configurationYou can configure an Essbase selection in IBM Cognos Integration Server.

Procedure

1. 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 a multidimensional datastorage system. The following graphic shows an Essbase outline. The background text is deliberatelyblurred.

Figure 2: Essbase outline

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

Figure 3: Essbase outline member selection

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


Procedure

1. In the IBM Cognos Integration Server navigation tree, click Selection Manager.2. In the Selection List window, select an Essbase selection.3. Click Open.4. Expand the outline by clicking the plus sign (+) of the outline node to find the desired member.

Alternatively, use the search function to search for a member. For more information, see“Searching foroutline members” on page 59.

5. To select a member, right-click the member and select a member selection function. The memberappears in the Member Selections window.

Attention: For some function types, it is possible to specify an input parameter to the function.The input parameters available depend on the outline. Some members might not allow allfunctions to be selected, depending on their position in the outline. For example, top membershave the ancestors functions disabled. If extraction type I is selected, only level 0 (zero)members of 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 select members from a list of allmembers of an outline.

Procedure

1. 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 “Selecting members froman Essbase outline” on page 47.

6. Click Add.7. Click Done.

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

About this task

The following substitution variables are supported by the IBM Cognos Integration Server:

• A single member, for example: 100-10.• A list of members, for example: 100-10, 200, 300, 400-10.• A level range, for example: Sep:Dec, which resolves into Sep, Oct, Nov, Dec. All members are at the

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

the same generation• 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 quotation marks ("") orbrackets ([]).

The Cognos Integration Server supports only members from the same dimension in the samesubstitution variable.


In the Member Selections section, the name of the substitution variable is prefixed with anampersand (&) to distinguish it from outline members.

When you search the outline for a substitution variable, the member that the variable resolves intois found.

For substitution variables that resolve into more than one member:

• The function is set to Select Member.• If a custom name is entered, only the first member is given the custom name.• When you are locating a substitution variable in the outline by right-clicking the variable and

selecting Locate, the first member is located.

Procedure

1. 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 selectionsUse the Essbase column selections to specify which Essbase dimensions to extract to the target in aselection.

The following table describes the Essbase column selections:

Table 3: Essbase column selections

Column Description

Export Selects a specific dimension to be extracted during metadata Extraction. TheExport check box also selects the dimension columns that are included in thefact table.

Attention: The dimension columns of attribute dimensions are empty ifthe corresponding base dimensions are not selected. If you useextraction type III and a text file target, the values of dimensioncolumns of attribute dimensions are empty.

Column/TM1Dimension

Lists all dimensions of the outline.


Table 3: Essbase column selections (continued)

Column Description

Key The key a.k.a. spin dimension is a concept unique to Oracle Essbase andPlanning selections. It is used when you extract data from a multi-dimensionalEssbase database to a two-dimensional row-column relational database or aflat file.

• Type I data extraction - For each selected member of the spin dimension, ablock of data based on the member selections of the other dimensions andthe data extraction options settings is extracted. If no stored members of thespin dimension are selected, all stored level zero members (leaf nodes) of thespin dimension are used in the extraction.

For best performance, select a dense dimension with the least number oflevel zero members.

Only level zero members of the spin dimension can be selected. For moreinformation, see “Selecting members from an Essbase outline” on page 47.

• Type II and IV data extraction - For best performance, select a sparsedimension. Any members of the spin dimension can be selected.

• Type III data extraction - Select a dense dimension. Any members of the spindimension can be selected.

Sort This setting controls the ordering of the dimension columns in the fact 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 of dimensions 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 aselected member to change the member selection 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 field of the respective dimensiontable and in the dimension columns of the fact table. Only member selections of function type SelectMember can have a custom name.

DimensionThe dimension to which the selected member belongs.

Essbase extraction typesThe IBM Cognos Integration Server provides four extraction types and several options for extracting datafrom Essbase BSO (Block Storage Option) and Essbase ASO (Aggregate Storage Option) models.

For Essbase ASO models, only extraction type II and type IV are available. For Essbase BSO models, allextraction types are available. Consider some of the following situations:

• To extract a large portion of the database (more than 10,000,000 intersection points or if the databaseis sparsely populated), type I, III, or IV will typically outperform type II.


• To extract data with many dynamic calculations from both dense and sparse dimensions, type II or typeIV might be the best choice.

• To use Intelligent Extraction from an Essbase cube, type I is the only choice.• Extraction types I and III are not supported for TM1 and SAP targets.

Because Essbase cubes and their internal structure can vary, you can experiment with different extractiontypes to get the best performance.

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

Table 4: 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 Type Append X X X X

Set Load Type Refresh X X X X

Set Load Type Merge X X X X

Extract Data withAliases

X X X X

Implicit Share Override X X

Intelligent Extraction X

Custom Data Value Filter X

Custom Scope Control X X

Set Extraction Buffer X X

Set Extraction Threads X X

Essbase Server SideExport

X X

Client Side Export X X

SQL Server Bulk Insert X X

Ideal Cube ExtractionSpace

Unlimited 10,000,000 orless

Unlimited Unlimited

Extraction of a SparseCube / Intersection

X X (Performancemight bereduced)

X X

Extraction of DynamicCalculations

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 for text file targets:


Table 5: Extraction type options supported for text file 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 Type Append X X X X

Set Load Type Refresh X X X X

Set Load Type Merge X

Extract Data withAliases

X X X

Implicit Share Override X X

Intelligent Extraction X

Custom Data Value Filter X

Custom Scope Control X X

Set Extraction Buffer X X

Set Extraction Threads X X

Essbase Server SideExport

X X

Client Side Export X

SQL Server Bulk Insert

Ideal Cube ExtractionSpace

Unlimited 10,000,000 orless

Unlimited Unlimited

Extraction of a SparseCube / Intersection


X X

Extraction of DynamicCalculations

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 and setting the specificextraction options for Planning+.

For information about configuring an Essbase Selection, see “Essbase selection configuration” on page46. It is not necessary to configure any Essbase column or member selections if only Extract PlanningDetails is selected.

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


HFM selection configurationConfiguring a Hyperion Financial Management (HFM) selection consists of setting the extraction optionsand selecting one or more members from each dimension of the HFM outline to extract if the dataextraction option is selected.

Selecting members from an HFM outline

You can select members from an HFM outline the same way as you do when you configure an Essbaseselection.

For information about configuring an Essbase selection, see “Essbase selection configuration” on page46.

Selecting members from an HFM member list

Selecting members from an HFM member list is different from selecting members from an Essbasemember list.

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

HFM member selection and column selections

The HFM Member Selections and Column Selections windows are similar to those in Essbase, exceptthat there is no Spin column and no Parameter column.

For more information, see “Essbase column selections” on page 49 and “Essbase member selections” onpage 50.

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.

Procedure

1. 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 from member list.5. Do one of the following steps:

• To select all members from a member list, double-click the member list, or alternately select themember list and click All. When the selection is run, all members from the member list are includedin the member selection, which is based on the member list definition that exists at the time theselection is run.

Note: To distinguish a member list from outline members, the name of the member list is prefixedwith an ampersand character (&) in the Member Selections window.

• To select individual members from a member list, select the member list and click SelectMembers. In the Add Members From Member List window, select members from the Member list.When finished, click Done.


TM1 selection configurationUse the Cognos Integration Server selection manager to configure a TM1 selection.

Procedure

1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, select a TM1 selection.3. Click Open.4. Click the Data Extraction Options tab.5. Set the extraction options.6. Select the output columns or TM1 target dimensions.7. Select the members of the TM1 cube to extract data from.

Selecting the output columns or dimensions of a TM1 selection

The following list describes the TM1 output columns or TM1 dimension selections:Export

Selects a specific TM1 dimension to be extracted during metadata extraction. The Export check boxalso selects the dimension columns that are included in the fact table for RDBMS or text targets orTM1 dimensions for TM1 targets.

ColumnThe name of the target dimension column or target TM1 dimension.

SortThis setting controls the ordering of the dimension columns in the fact table for RDBMS and texttargets and TM1 dimensions for TM1 targets. The first column is the one with a Sort value of 0 (zero).Values must be zero-based and no larger than the number of dimensions minus one.

Selecting members of a TM1 selection

Member selections determine the data that is extracted. Select members by right-clicking on members ofthe TM1 cube outline and choose a member selection function.

The following list describes the TM1 member selections:Member

The name of the selected TM1 member.Function

The member selection function. Right-click on the function to change it.Parameter

Any parameters required by the member selection function. For example, the Select members fromhere based on level function requires a level number. A parameter of Level 0 would select all leaflevel members below the selected member.

Custom NameAn optional custom name for the selected member.

Attention: Not all selection functions support custom names.

DimensionThe TM1 dimension of the selected member.


SAP BW InfoCube selection and configurationUse the Cognos Integration Server selection manager to configure an SAP BW InfoCube selection.

Procedure

1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, select an SAP BW InfoCube selection.3. Click Open.4. Click the Data Extraction Options tab.5. Set the extraction options.6. Configure the output columns or TM1 dimensions.7. Select the members of the SAP BW InfoCube to extract data from.

Configuring the output columns or dimensions of an SAP BW InfoCube selection

The following list describes the SAP BW InfoCube columns / TM1 dimensions selections:Column / TM1 Dimension

The name of the target fact table dimension column or TM1 target dimension.Custom Name

An optional custom name of the fact table dimension column or TM1 target dimension.Sort

This setting controls the ordering of the dimension columns in the fact table for RDBMS and texttargets and TM1 dimensions for TM1 targets. The first column is the one with a Sort value of 0 (zero).Values must be zero-based and no larger than the number of dimensions minus one.

DimensionThe name of the source SAP BW dimension.

CharacteristicThe name of the source SAP BW characteristic.

HierarchiesA list of the selected hierarchies for this characteristic separated by commas. Click the ellipsis (…) tochange the selected hierarchies.

AttributesA list of the selected attributes for this characteristic separated by commas. Click the ellipsis (…) tochange the selected attributes.

Configuring the metadata tables and dimension columns in the target fact table (for RDBMS targets) or theTM1 dimensions and cube (for TM1 targets) consists of selecting one or more characteristics, attributes,and key figures from the SAP BW InfoCube outline.

Selecting characteristics as output columns or TM1 dimensions

Right-click on a characteristic and choose Select as Column or Select as TM1 Dimension to add thecharacteristic to the column / dimension selections table. The default hierarchy of the characteristic isautomatically selected.

As an alternative method, right-click on a hierarchy and choose Add Hierarchy to Column Selections orAdd Hierarchy to Dimension Selections to add its characteristic and the hierarchy to the column /dimension selections table.

To select a different hierarchy, click the Hierarchies ellipsis in an output column or dimension to open theHierarchies and Attributes List Editor.

Attributes can be extracted as part of its characteristic to the metadata tables or TM1 dimensions.Initially, no attributes are selected as part of a characteristic column / dimension selection. Click the


Attributes ellipsis in an output column or dimension to open the Hierarchies and Attributes List Editor andadd attributes from the list of available attributes.

As an alternative method of adding attributes to a characteristic column / dimension selection, right-clickon the attribute and choose Select Attribute. If the characteristic of the attribute has not been added, itis added.

Selecting attributes as output columns or TM1 dimensions

Attributes can be extracted as dimensions. Right-click on an attribute in the SAP BW InfoCube outline andchoose Select as Column or Select as TM1 Dimension.

Selecting Key Figures as output columns or TM1 dimensions

SAP BW Measures are members of a special dimension known as Key Figures. To add the Key Figuresdimension, right-click on the Key Figures node in the SAP BW InfoCube outline and choose Select asColumn or Select as TM1 Dimension. The Key Figures dimension is always the spin dimension. Using theWide format fact table creates one column for each Key Figures member. The Wide format Key Figurescolumns or TM1 dimensions can be given an optional custom name in the Custom Name field of the KeyFigure member selection.

Selecting members from an SAB BW InfoCube outline

The following list describes the SAP BW InfoCube member selections:Member

The name of the selected member.Function





DimensionThe name of the member’s source SAP BW dimension.

CharacteristicThe name of the member’s source SAP BW characteristic.

HierarchyThe name of the member’s source SAP BW hierarchy.

Member selections determine the data that is extracted. Select members by right-clicking on members ofthe SAP BW InfoCube outline and choose a member selection function.

By default, Cognos Integration Server extracts data from all members of a selected characteristic if nomembers of that characteristic are selected.

Hierarchies and characteristics with no members selected and TM1 as the target

Hierarchy selection does not affect the data extraction. By default Cognos Integration Server extractsdata for all members in every selected characteristic.

This means that if the hierarchies you select don't contain all members that are found in theircharacteristics then you get an error from TM1.


Usually this is not the case since SAP BW hierarchies usually contain all members found in theircharacteristic (either added by the user or by SAP BW under the Not Assigned member).

However, some hierarchies do not contain all these members (the ones in the 0CALDAY characteristic, forexample). In those cases, you need to select one or more members to ensure that only data for memberspresent in the TM1 dimension is extracted.

SAP BW InfoQuery selection and configurationUse the Cognos Integration Server selection manager to configure an SAP BW InfoQuery selection.

Procedure

1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, select an SAP BW InfoQuery selection.3. Click Open.4. Click the Data Extraction Options tab.5. Set the extraction options.6. Configure the output columns or TM1 dimensions.7. Select the members of the SAP BW InfoQuery to extract data from.8. Select Query Variables.

Configuring the output columns or dimensions of an SAP BW InfoQuery selection

The following list describes the SAP BW InfoQuery columns / TM1 dimensions selections:Column / TM1 Dimension

The name of the target fact table dimension column or TM1 target dimension.Custom Name

An optional custom name of the fact table dimension column or TM1 target dimension.Sort

This setting controls the ordering of the dimension columns in the fact table for RDBMS and texttargets and TM1 dimensions for TM1 targets. The first column is the one with a Sort value of 0 (zero).Values must be zero-based and no larger than the number of dimensions minus one.

DimensionThe name of the source SAP BW dimension.

CharacteristicThe name of the source SAP BW characteristic.

Selecting characteristics as output columns or TM1 dimensions

Right-click on a characteristic and choose Select as Column or Select as TM1 Dimension to add thecharacteristic to the column / dimension selections table.

As an alternative method, right-click on a hierarchy and choose Add Hierarchy to Column Selections orAdd Hierarchy to Dimension Selections to add its characteristic and the hierarchy to the column /dimension selections table.

Selecting Key Figures as output columns or TM1 dimensions

SAP BW Measures are members of a special dimension known as Key Figures. To add the Key Figuresdimension, right-click on the Key Figures node in the SAP BW InfoQuery outline and choose Select asColumn or Select as TM1 Dimension. The Key Figures dimension is always the spin dimension. Using theWide format fact table creates one column for each Key Figures member. The Wide format Key Figurescolumns or TM1 dimensions can be given an optional custom name in the Custom Name field of the KeyFigure member selection.


Selecting members from an SAB BW InfoQuery outline

The following list describes the SAP BW InfoQuery member selections:Member

The name of the selected member.Function





CharacteristicThe name of the member’s source SAP BW characteristic.

Member selections determine the data that is extracted. Select members by right-clicking on members ofthe SAP BW InfoQuery outline and choose a member selection function.

By default, Cognos Integration Server extracts data from all members of a selected characteristic if nomembers of that characteristic are selected.

Selecting Query Variables

Cognos Integration Server can extract data from InfoQueries that have variables. The variables that areused in the InfoQuery are found under the Variables node in the Outline Tree. There are two ways to set avalue for a variable.

You can right-click and select Enter Value. This adds the variable to the Member Selection. There you canadd the value of the variable in the Parameter column. The format of the value must be compatible withMDX because it is inserted into an MDX statement generated by Cognos Integration Server.

Alternatively, you can right-click and hover over Select Value. This expands into a list of possible valuesfor that variable. You can select the value that you want from the list.

Select or enter multiple values for the same variable by right-clicking on the variable and selecting theoption again.

Star schema selection configurationUse the Cognos Integration Server selection manager to configure a Star schema selection.

Procedure

1. Click Selection Manager in the IBM Cognos Integration Server navigation tree.2. In the Selection List window, select a Star schema selection.3. Click Open.4. Click the Data Extraction Options tab.5. Set the extraction options.6. Select the output columns or TM1 target dimensions.7. Select the members of the Star schema cube to extract data from.

Selecting the output columns or dimensions of a Star schema selection

The following list describes the Star schema output columns / TM1 dimension selections:


ExportSelects a specific star schema dimension to be extracted during metadata extraction. The Exportcheck box also selects the dimension columns that are included in the fact table for RDBMS or texttargets or TM1 dimensions for TM1 targets.

Column / TM1 DimensionThe name of the target dimension column or target TM1 dimension.

SortThis setting controls the ordering of the dimension columns in the fact table for RDBMS and texttargets and TM1 dimensions for TM1 targets. The first column is the one with a Sort value of 0 (zero).Values must be zero-based and no larger than the number of dimensions minus one.

Selecting members of a TM1 selection

Member selections determine the data that is extracted. Select members by right-clicking on members ofthe star schema cube outline and choose a member selection function.

The following list describes the TM1 member selections:Member

The name of the selected TM1 member.Function





DimensionThe TM1 dimension of the selected member.

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

Procedure

1. From the Selection Manager, click the selection that contains the outline that you want to search.2. To search for a specific member in an outline, enter the name or a part of the name in the search box

and click the search icon. You can click the search icon drop-down button to modify the searchoptions.To search for more matches of the same name, click the search button again.

Searching for outline members in a list viewYou can view the outline members as a list as an alternative to the outline tree view, which can displayonly a limited number of children under a parent node.

About this task

You can select a member in the list view in the same way as from the tree view. Right-click on a memberand select a function from the member function menu.


Figure 4: Right-click function menu on a member

The list view and tree view are synchronized. If you select a node in the tree view, then switch to list view,you see the node that is selected in the members list.

Procedure

Click the Switch to List View icon on the search toolbar.

Figure 5: The Switch to List View icon

Nodes that have children are marked with a ‘>’ sign. The search icon is transformed into a Filter icon. TheSwitch to List View icon becomes a Switch to Tree View icon.


Figure 6: The list view

• To navigate deeper into the tree hierarchy, double-click a node that has children or click the ‘>’ sign.• To go back, click the Back icon on the toolbar.

You can also go back directly to a certain ancestor by clicking the ancestor name in the toolbar. Thetoolbar does not display more than three ancestors.

The list view and tree view are synchronized. If you select a node in the tree view, then switch to list view,you see the node that is selected in the members list.

To filter the list of members, enter a member name or part of a member name in the filter text box andthen click the Filter icon. Only the current list of children is filtered, unlike the tree view search feature,which filters the entire outline.

The filter menu options are similar to the search menu options. Additionally, you can enter a regularexpression into the filter text box by checking the Use regular expressions menu option. Only one of theUse regular expressions or Match whole word only options can be checked at a time.

Figure 7: The list view filter menu options

You can go back to the original members list by clearing the filter text box.

A tree view can display only a limited number of children under a parent. If the count of children exceedsthe number, then a More node is displayed. You can double-click the More node to switch to a list viewthat shows the entire list of children. Also, if you search in tree view for a node that cannot be displayedby this control, the view is automatically switched to list view, where you can see that node.


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

Procedure

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

Connection parametersThe following describes the parameters available for each connection type.

Source connection type parameters

IBM Cognos TM1 source connection parametersThe following describes the Cognos TM1 connection parameters for source connections.

URL Connection / Connect using Admin Server

There are two ways to connect to a TM1 server. You can either specify the URL of the TM1 server directly,or you can use a TM1 admin server to obtain a list of available TM1 servers to choose from. The formermethod is typically used for connecting to TM1 servers in the Cloud. The latter method is normally usedfor on-premise TM1 servers

The following parameters are for connecting using a TM1 admin server:

Admin ServerThe name of the TM1 administration server.

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

Admin Server uses SSLSelect to connect to the TM1 Admin Server using SSL, otherwise leave unselected.

TM1 ServerThe name of the TM1 data server.

The following parameters are for connecting using a URL connection:

Request TimeoutIBM Cognos Integration Server cancels a request to TM1 if no reply received within this amount oftime, in seconds. Set the value to 0 for an infinite waiting time. The default value is 300 seconds.

The following parameters are for both connection types:

TM1 URLThe URL of the TM1 data server.

TM1 AuthenticationIBM Cognos Integration Server supports three TM1 authentication types.

• Basic - Standard TM1 authentication is mapped to HTTP Basic authentication where the user nameand password are passed on to the TM1 server.

• CAM Namespace - The authentication is done by TM1 by specifying the CAM Namespace ID, UserName, and Password connection parameters. Authentication is done against the configured IBMCognos BI or Cognos Authentication Manager (CAM) of the TM1 server.

• CAM Passport - The authentication is done on the Cognos Integration Server side and might requireuser interaction if the CAM Passport was not already acquired or has expired. CAM Passport


authentication is not supported in an automation environment from the CLI (Command LineInterface) because it requires user interaction to fill in the user credentials.

The following parameters are for Basic and CAM Namespace authentication:

CAM Namespace IDThe Cognos Access Management namespace ID (CAM Namespace authentication only).

User NameThe TM1 data server user name.

PasswordThe TM1 data server password.

The following parameters are for TM1 source connections:

CubeThe name of the TM1 cube.Type the name of the TM1 source cube or click the drop-down to select from a list of available TM1cubes.

SAP BW source connection parametersThis section describes the SAP BW source connection parameters for both InfoCubes and InfoQueries.Server

The name of the SAP server.User Name

The SAP server user name.Password

The SAP server password.System Number

The system number of the SAP server that you want to connect to.Client

The client used by the connection.Language

The language used by the connection.Codepage

The codepage used by the connection.InfoCube or InfoQuery

The name of the InfoCube or InfoQuery.Type the name of the SAP InfoCube or InfoQuery or click the drop-down to select from a list ofavailable InfoCubes or InfoQueries.

SAP BW/4HANA connection parametersThis section describes the source connection parameters for SAP BW/4HANA.Server





The client used by the connection.


LanguageThe language used by the connection.

CodepageThe codepage used by the connection.

InfoCubeThe name of the InfoCube.Type the name of the SAP InfoCube or click the drop-down to select from a list of available InfoCubes.

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

Attention:

• IBM Cognos Integration Server source star schemas must be in parent-child format. The starschemas must be complete, that is, they must have a fact table and all metadata tables thatcorrespond to the fact table dimension columns and the wide dimension, if one exists.

• Cognos Integration Server supports star schemas from CIS, Essbase, Planning, HFM, TM1, andStar Schema extractions.

The following list describes the connection parameters that are unique to Cognos Integration Server starschema:

PrefixThe 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 star schema prefix). This parametershould be defined only if the source fact table is in wide format.

In addition to these parameters, Cognos Integration Server star schema supports RDBMS connections ofvarious types. For more information, see “SQL Server trusted connection parameters” on page 76, “SQLServer login connection parameters” on page 76, “Oracle connection parameters” on page 77, and“IBM DB2 connection parameters” on page 78.

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

The Star Schema Connection Manager is comprised of two panels:

• The RDBMS connection parameters panel (top)• The Star Schema parameters panel (below)


RDBMS parameters panelUse the Connection Parameters panel in the Star Schema Connection Manager to define connectionvalues for the Star Schema.

Connections to the following datasources are supported:

• DB2


• ODBC• Oracle• SQL Server

Connections to the following CIS repositories are supported:

• DB2• Oracle• SQLite• SQL Server

Note: Connection Parameter fields will vary depending on the connection type.

Star Schema parameters panelUse the parameters panel in the Star Schema Connection Manager to define values for the Star Schema.

Type

• Star Schemas may be of 2 types: CIS or Generic. CIS star schemas can be defined as CIS orGeneric type. ICM and any other star schemas need to be defined as Generic type. The defaultoption is Generic.

Note: Choosing Generic allows you to move forward to the next Star Schema Wizard tabs: “FactTable Details tab” on page 69 and “Dimension Table Details tab” on page 70.

• If you define the type as Generic, the Prefix and Spin Dimension Table fields will be disabled.• If you define the type as CIS, the Prefix and Spin Dimension Table fields will be enabled.

Fact Table

The Fact Table field allows you to select a fact table for your star schema.

• If you have selected the Generic type, you may choose a fact table name from all available tablenames in the specified database.


• If you have selected the CIS type, this list of tables is restricted to those starting with the specifiedPrefix field, and those resembling a CIS fact table (ex. having an AUDITID column)

Prefix

The Prefix field allows you to specify the CIS star schema prefix. Defining the Prefix will filter the listof fact tables in the Fact Table and Spin Dimension Table fields.

Spin Dimension Table

If the fact table is in wide format, the Spin Dimension Table field allows you to specify a dimensiontable, which describes the dimension containing wide members.

Creating a connectionConnections are paths between data sources from which data is extracted and targets in which extracteddata is stored. Each connection has its own unique connection ID.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation tree.2. From the toolbar, click New Source Connection.3. Click Star Schema.4. Select a connection type.5. You can change the default connection details for your specific connection, such as Name and

Description, to make them more meaningful.

Appropriate parameters for the type of connection are displayed.

Note: Connection Parameter fields will vary depending on the connection type.6. Edit the connection parameters or select values from the drop-down lists.

For more information, see “Connection parameters” on page 62 and “RDBMS parameters panel” on page65.

7. Edit the Star Schema parameters or select values from the drop-down lists.


For more information, see “Star Schema parameters panel” on page 66.8. Click Test to test the connection.9. If you Star Schema type is CIS, click OK to save your settings, or click Cancel to close the window

without saving your connection.10. If you Star Schema type is Generic, click Next>> to proceed to the “Fact Table Details tab” on page

69, or click Cancel to close the window without saving your connection.


Fact Table Details tabThe Fact Table Details tab loads the fact table schema. All column names are displayed in a data grid.

About this task

Column NameThis column lists the names of the dimensions in the fact table.

Column TypeThis column allows you to define the column type as either:

• Dimensional: Columns representing dimensions. If you define a column type as Dimensional, youmust specify a dimension table in the corresponding Dimension Table drop-down.

• Measures: Columns representing data. If you define a column type as Measures, you may specify adimension table in the corresponding Dimension Table drop-down. If no dimension table isspecified, you may specify a dimension name in the Measures dimension name field.

• Ignore: Columns, which won't be taken into account by the selection.

Dimension TableThis column allows you to define a dimension table for the corresponding row.

Note: The Dimension Table name cannot coincide with the Column Name.

Procedure

1. You can edit connection details for your specific connection, such as Name and Description.2. Define the Column Type for the dimensions in the fact table.3. If applicable, define the Dimension Table for the dimensions in the fact table.4. If no dimension table is specified, you may specify a dimension name in the Measures dimension

name field.5. Click <<Back to return to the Connection Manager window, Next>> to proceed to the Dimension Table

Details tab, or Cancel to close the window without saving your connection.


Dimension Table Details tabThe Dimension Table Details tab loads dimension tables specified in the Fact Table Details tab.

About this task

Dimension Table drop-downChoose a dimension table from this drop-down to load the list of columns from the selecteddimension table in the pane below.

Column NameThis column lists the member names for the selected dimension table.

Column TypeThis column allows you to assign a markup for the corresponding dimension member. Use this columnto define a child-parent pair to build an outline in the selection. Define the pair that describes thedimension hierarchy in the dimension table; this pair can either be Child ID and Parent ID, or ChildName and Parent Name.

• Child ID: If selected, is used for the child member name display in the outline. Child ID is used fordata exports with the Member Names option enabled.

• Parent ID: If selected, is used for the parent member name display in the outline. Parent ID is usedfor data exports with the Member Names option enabled.

• Child Name: If selected, is used for the child member name display in the outline. Child Name isalso used for data exports with the Member Names option enabled.

Note: If Child Name is not selected, Child ID is used for data exports with the Member Namesoption enabled.

• Parent Name: If selected, is used for the parent member name display in the outline. Parent Nameis also used for data exports with the Member Names option enabled.

Note: If Parent Name is not selected, Parent ID is used for data exports with the Member Namesoption enabled.

• Alias: If selected, is used to mark columns in the outline build that represent alternative names for adimension member. An Alias column is inserted in the outline, alongside the member name and isexported in the target fact table if the Use Alias option is enabled.


• Attribute: If selected, is used to mark columns in the outline build that represent attributes for adimension member.

• Other: If selected, is used to mark columns in the outline build that don't have a special meaning,but need to be exported as meta data further on from the selection.

• Ignore: If selected, will indicate that the column is not to be taken into account.

Note: If both child-parent pairs (Child Name / Parent Name and Child ID / Parent ID) exist, ChildID / Parent ID is used in the outline build.

Is Fact KeyIf selected, is used to indicate columns that are used in the source fact table (columns which themember name/alias/IDs are taken from). Select Is Fact Key to identify member intersections in thefact table.

Procedure

1. You can edit connection details for your specific connection, such as Name and Description.2. Define the Column Type for the members in the dimension table.3. Select Is Fact Key to indicate columns that are used in the source fact table.4. Click <<Back to return to the “Fact Table Details tab” on page 69, Finish to save your settings, or

Cancel to close the window without saving your connection. If you configure only one dimension tableand click Finish without configuring all other dimension tables (if they exist), you will have the optionof applying your configuration to all other dimension tables as well. You may apply your configurationsto all other dimension tables if all other dimension tables have a similar structure.

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

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 Show Status, then click Test to view the results in the statuswindow.

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

About this task

If the connection is in use, only parameters like User Name or Password can be edited.

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

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation 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 connection that is no longerneeded, first delete the selection and then delete the connection. For information about viewing a list ofselections that use the connection, see “Viewing connection uses” on page 25.

Procedure

1. Click Connection Manager in the IBM Cognos Integration Server navigation tree.2. In the Connection List window, select a connection.3. Click Delete.

Tip: To delete multiple connections, press Ctrl and click each connection, or press Shift and click toselect a range of connections.

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 as the Essbase Databaseparameter.

User NameThe user name for logging in to Essbase. Typically a user with Admin or Supervisor 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 Essbase database in the sameway as a regular Essbase connection. The second part connects to the relational database managementsystem (RDBMS) where the Planning data is stored.

Attention: In the New Oracle Hyperion Planning Source Connection window, in RDBMSConnection Type, select the RDBMS connection type before you configure a Planning connection.

Essbase Planning connection parameters

The following list describes the Essbase connection parameters that are the first part of the Planningconnection 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 as the Essbase Databaseparameter.

Essbase User NameThe user name for logging in to Essbase. Typically a user with Admin or Supervisor 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 with a login connection:

SQL ServerThe name of the SQL Server.

To connect to a non-default instance, add a back slash (\) and the instance name 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 load data.

PasswordThe password for the Oracle Login Name parameter.

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

PortThe 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 a connection cannot be madewithin 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 before it times out.


RDBMS connection parameters for SQL Server with a trusted connection

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

RDBMS connection parameters for an Oracle connection

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

Oracle ServerThe name of the server where the Oracle target database is located. You can also use a TNS name, ifused.

SIDThe Oracle SID on the Oracle server. Leave the Service Name parameter blank to use the SIDparameter.


Service NameThe Oracle service name on the Oracle server. Leave the SID parameter blank to use the ServiceName parameter.

PortThe application port number that is used by the Oracle instance on the specified host.


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

PasswordThe password for the Oracle User Name parameter.

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

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

The following list describes the HFM connection parameters:

HFM ClusterThe name of the Hyperion HFM server cluster. The cluster can be local to the IBM Cognos IntegrationServer or on remote computers.

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

To connect to a specific HFM server in the cluster use the cluster name followed by the name of theserver separated by a backwards slash. For example: MyCluster\MyServer. This is only availablefor clusters of HFM 11.1.2.4 servers or above.

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 the HFM server and domainspecified.

HFM AdminUserThe HFM user with privileges over the selected HFM application that is used to extract data andmetadata.

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

Satellite server connection parameters

You can specify the satellite server connection parameters.

For more information, see “Enabling a Connection to use a satellite server” on page 23.

ServerSatellite server name.

Port NumberThe default port numbers for a satellite server are 8009 for TCP and 8010 for HTTP.

ProtocolTCP or HTTP.

Attention: HFM connections might use either a local server or a Satellite Server. For MicrosoftWindows 2003/2008 x64 Standard Edition operating systems, only satellite server connectionsare available. In that case, a satellite server must be installed on the local Cognos IntegrationServer computer.


Target connection type parameters

IBM Cognos TM1 connection parametersThe following describes the Cognos TM1 connection parameters for target connections.

URL Connection / Connect using Admin Server

There are two ways to connect to a TM1 server. You can either specify the URL of the TM1 server directly,or you can use a TM1 admin server to obtain a list of available TM1 servers to choose from. The formermethod is typically used for connecting to TM1 servers in the Cloud. The latter method is normally usedfor on-premise TM1 servers

The following parameters are for connecting using a TM1 admin server:

Admin ServerThe name of the TM1 administration server.

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

Admin Server uses SSLSelect to connect to the TM1 Admin Server using SSL, otherwise leave unselected.

TM1 ServerThe name of the TM1 data server.

The following parameters are for connecting using a URL connection:

Request TimeoutIBM Cognos Integration Server cancels a request to TM1 if no reply received within this amount oftime, in seconds. Set the value to 0 for an infinite waiting time. The default value is 300 seconds.

The following parameters are for both connection types:

TM1 URLThe URL of the TM1 data server.

TM1 AuthenticationIBM Cognos Integration Server supports three TM1 authentication types.

• Basic - Standard TM1 authentication is mapped to HTTP Basic authentication where the user nameand password are passed on to the TM1 server.

• CAM Namespace - The authentication is done by TM1 by specifying the CAM Namespace ID, UserName, and Password connection parameters. Authentication is done against the configured IBMCognos BI or Cognos Authentication Manager (CAM) of the TM1 server.

• CAM Passport - The authentication is done on the Cognos Integration Server side and might requireuser interaction if the CAM Passport was not already acquired or has expired. CAM Passportauthentication is not supported in an automation environment from the CLI (Command LineInterface) because it requires user interaction to fill in the user credentials.

The following parameters are for Basic and CAM Namespace authentication:

CAM Namespace IDThe Cognos Access Management namespace ID (CAM Namespace authentication only).

User NameThe TM1 data server user name.

PasswordThe TM1 data server password.

The following parameters are for TM1 source connections:


SAP BW connection parametersThis section describes the SAP BW target connection parameters for both InfoQueries and DSO.Server







The codepage used by the connection.

SAP BW/4HANA target connection parametersThis section describes the target connection parameters for SAP BW/4HANA.Server







The codepage used by the connection.

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 Server login connections, withthe exception that there is no Login Name parameter to specify.

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

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 instance name 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 load data.

PasswordThe password for the Oracle Login Name parameter.


PortThe 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 the SQL Server if a connectioncannot be made within this amount of time, in seconds.


Command TimeoutLength of time, in seconds, that a query can run on the SQL Server before it 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. You can also use a TNS name, ifused.

SIDThe Oracle System ID (SID) on the Oracle server. The SID uniquely identifies a particular database ona system. Leave the Service Name parameter blank to use the SID parameter.

Service NameThe Oracle service name on the Oracle server. Leave the SID parameter blank to use the ServiceName parameter.

PortThe application port number that is used by the Oracle instance on the specified host.


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

PasswordThe password for the Oracle User Name parameter.


Connection TimeoutThe Oracle server cancels a connection request if a connection cannot be made within this amount oftime, 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 of time, 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 is used as the schema name.

PortThe 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 made within this amount of time,in seconds.

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

System Catalog NameThe name of the DB2 system catalog. Use the name SYSCAT.TABLES for Microsoft Windows and AIX®

DB2 databases. Use the name SYSIBM.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 path parameter is added to the filename if the name does not have a fully qualified path included.

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

PathThe path where data and metadata output is placed.

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

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

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

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

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 column headers out of the fact tables,type NO.

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

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

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

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

Move data

Using IBM Cognos Integration Server, you can move your data between TM1 and SAP BW InfoCubes,InfoQueries, or BW/4HANA. The topics below describes the processes to move your data.

Move data from TM1 cubes to SAP BW InfoCubes or DSOsYou can move your data from TM1 cubes to existing SAP BW InfoCubes and DSOs using IBM CognosIntegration Server.

Before you begin

The following are required to move data from TM1 cubes to existing SAP BW InfoCubes and DSOs.

• TM1 REST API. Ensure that your version of TM1 supports the TM1 REST API.• SAP RFC SDK and SAP .NET Connector v3.• SAP BW libraries. You must install the .dll files next to the ICIS.exe executable.

Note: Ensure that the DSO has the Direct Update property enabled.

Procedure

1. Create an IBM Cognos TM1 source connection.

An IBM Cognos TM1 source connection is required for you to move your data from a TM1 cube. Use theConnection Manager to create the IBM Cognos TM1 source connection.

2. Create an SAP BW InfoCube or DSO target connection.


An SAP BW InfoCube or DSO target connection is required for you to import your data into an SAP BWInfoCube or DSO. Use the Connection Manager to create the SAP BW InfoCube or DSO targetconnection.

Note: The name defined in the SAP BW InfoCube or DSO target connection will only define the name ofthe SAP BW InfoCube or DSO target connection. The name of the target SAP BW InfoCube or DSO isdefined in the TM1 selection.

3. Create a TM1 selection.

Create a TM1 selection to extract data from. Use the Selection Manager to create the TM1 selection.Define any applicable fields in the Selection Information, Cube Options, and Data ExtractionOptions tabs.

Define the name of the target SAP BW InfoCube or DSO, the dimension selections and the memberselections. These fields determine name of the target SAP BW InfoCube or DSO, and which membersand dimensions are extracted and imported to SAP BW InfoCube or DSO. Ensure that you know thename of the InfoCube or DSO you want to write to.


You also need to know the corresponding info objects (characteristics and key figures) for eachdimension that you're extracting from TM1. For each exported dimension from TM1, you need tospecify the name of corresponding characteristic in the SAP BW InfoCube or DSO. Thiscorrespondence is made by writing the name of the SAP BW characteristic in the Custom Namecolumn of the TM1 dimension, in the Column Selections table.

Specify the TM1 measures to extract to SAP BW InfoCube or DSO.

Note: The last dimension in TM1 is the measure dimension. When exporting from TM1, the lastdimension must be selected and set as a key. The key dimension is sometimes referred to as the spindimension.

Use the Custom Name column, in the Member Selection table to specify which SAP BW key figuresthe data from the TM1 measures will be written to.

4. Extract data from TM1 to SAP BW InfoCube or DSO.

Click Run from your TM1 selection.

ResultsYour data is transferred from TM1 to SAP BW InfoCube or DSO.

To learn more about the Connection Manager and creating connections, see “Creating a connection” onpage 23.

To learn more about creating selections, see “Creating a selection” on page 26.

To learn more about the Selection Manager, see “The Selection Manager” on page 25.

For the IBM Cognos TM1 source connection parameters, see “IBM Cognos TM1 source connectionparameters” on page 62

For the SAP BW InfoCube or DSO target connection parameters, see “SAP BW connection parameters” onpage 76.


Move data from SAP BW InfoCubes or InfoQuery to TM1You can move your data from SAP BW InfoCubes and InfoQueries to TM1 cubes using IBM CognosIntegration Server. You can also move your data from composite providers in SAP BW/4HANA using thesame process described in this topic.

Before you begin

The following are required to move data from SAP BW InfoCubes and InfoQueries to TM1 cubes:

• The DLLs required for SAP BW.• TM1 REST API. Ensure that your version of TM1 supports the TM1 REST API.• SAP RFC SDK.• SAP .NET Connector v3.• SAP BW libraries. You must install the .dll files next to the ICIS.exe executable.

Procedure

1. Create an SAP BW InfoCube or InfoQuery source connection.

An SAP BW source connection is required for you to move your data from SAP BW. Use the ConnectionManager to create the SAP BW source connection.

2. Create a TM1 target connection.

A TM1 target connection is required for you to import your data into a TM1 cube. Use the ConnectionManager to create the TM1 target connection.

3. Create an SAP BW selection.


Create an SAP BW selection to extract data from. Use the Selection Manager to create the SAP BWselection. Define any applicable fields in the Selection Information, Cube Options, MetadataExtraction Options, and Data Extraction Options tabs.

a) Define your dimension names and member names.

Dimensions exported into TM1 cubes will have names based on the SAP BW cube or dimension'sprefix combined with the name of the characteristic, attribute, or Key Figures.

You can use the Custom Name fields to define a custom name for the SAP BW dimensions.

You can also define custom names for the dimensions in the Table and Column Name Mappingtab. The Table and Column Name Mapping tab is located under Tools > Options....

Member names extracted to a TM1 cube are based on the SAP BW display names and technicalnames.

You can change the display names and technical names being exported into TM1. You can changethe names either in the Custom Name field, under Member Selections, or in the Member NameMapping tab. The Member Name Mapping tab is located under Tools > Options.... You may berequired to change the names of your members if the member name contains a characterincompatible with TM1, or if the member name already exists (TM1 is case insensitive. Nameswhich were considered unique due to case in SAP BW may not be in TM1).

b) Select dimensions to export into the TM1 cube.


SAP BW characteristics, attributes, and Key Figures can be extracted into a TM1 cube asdimensions.

To extract SAP BW characteristics or Key Figures into TM1 cube as dimensions:

1) Locate the characteristic or Key Figure in the outline tree.2) Right-click the characteristic or Key Figure.3) Click Select as TM1 Dimension

To extract SAP BW attributes into TM1 cubes as dimensions:

1) Locate the desired attribute in the outline tree.2) Right-click the attribute.3) Click Select as TM1 Dimension

c) Select hierarchies to export into the TM1 cube as dimensions.

To select the hierarchy from the outline tree:

1) Locate the desired hierarchy in the outline tree.2) Right-click the hierarchy.3) Click Add Hierarchy to Dimension Selections.


To select the hierarchy from the Dimensions Selections table:

1) Locate the Hierarchies column in the Dimension Selections table.

2) Open the Hierarchies List Editor by clicking the ellipses cell .3) Select your desired hierarchies from Available Hierarchies of 'Item' Characteristic.

4) Click the add icon to move the hierarchies to Selected Hierarchies.5) Click OK

Note: When you export an SAP BW hierarchy to TM1 as a dimension, the member structure of thenew TM1 dimension replicates the member structure of the SAP BW hierarchy. If multiple SAP BWhierarchies are selected for a characteristic, a TM1 member is created for each hierarchy, and thehierarchy's structure is replicated.

d) Select attributes to export into the TM1 cube as dimensions.

To export an SAP BW attribute as an attribute from the outline tree:

1) Locate the desired attribute in the outline tree.2) Right-click the attribute.3) Click Select Attribute.


To export an SAP BW attribute as an attribute from Dimension Selections table:

1) Locate the Attributes column in the Dimension Selections table.

2) Open the Attributes List Editor by clicking the ellipses cell .3) Select your desired attributes from Available Attributes of 'Item' Characteristic.

4) Click the add icon to move the attributes to Selected Attributes.5) Click OK

Note: All attributes selected from an SAP BW characteristic is created for the TM1 dimension.Members without an attribute will contain no attribute values.

4. Select members to export into the TM1 cube.

Select members to extract slices of SAP BW data into TM1. If no members are selected, data will beextracted from the whole dimension.

a. Locate the desired member in the outline tree.b. Right-click the member.c. Click the desired member option from the menu.


5. Extract data from SAP BW InfoCubes and InfoQueries to TM1.a) Set the extraction options from the Data Extraction Options tab, in the Selection Manager.

b) Set the options from the Cube Options tab, in the Selection Manager.c) Click Run from your SAP BW selection.

ResultsYour data is transferred from SAP BW InfoCubes and InfoQueries to TM1.

Tip:

1. Use the search function in the outline tree to find specific members faster.

2. Switch to List View if the outline tree contains more than 10,000 members.

List View allows you to view outline trees with more than 10,000 members.


To learn more about the Connection Manager and creating connections, see “Creating a connection” onpage 23.

To learn more about creating selections, see “Creating a selection” on page 26.

To learn more about the Selection Manager, see “The Selection Manager” on page 25.

For the Data Extraction Options, in the Selection Manager, see “SAP BW data extraction options” onpage 34.

For the Cube Options, in the Selection Manager, see “Cube options” on page 33.

For the IBM Cognos TM1 source connection parameters, see “IBM Cognos TM1 source connectionparameters” on page 62

For the SAP BW InfoCube or DSO target connection parameters, see “SAP BW connection parameters” onpage 76.

The Log ViewerThe Log Viewer provides a list of log records for viewing errors, warnings, or other information from theIBM Cognos Integration Server.

The Cognos Integration Server has a single logging point where all log information is directed to a table inthe Integration Server database. You can filter and export the log view.

In addition to standard logging of Cognos Integration Server activity, a process ID is assigned to all logrecords associated with the running of a selection during the process run. You can use the process ID as afilter to track the history of a process. For more information, see “Filtering the log results” on page 89.

The Log Viewer contains the following information:LogID

Log record identifier.Entry Date

Date and time the log record was entered.ProcessID

Each selection run has a unique process ID. If the Process ID is -1, then the log record is notassociated with a selection run.

TypeType of log record:

• ERRORS: Selection run failures and errors in the program.• WARNINGS: A selection run is completed but the results might not be as expected.• INFORMATION: Information and debug messages.


EntryDescription of the log entry.

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

MachineServer that generated the log entry.

UserOperating system user that performed the operations that result in the log entry.

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 about IBM Cognos IntegrationServer activity history more readable.

Procedure

In the IBM Cognos Integration Server tree, click Log Viewer.

• To filter based on type, from the Log Viewer window, click the Errors, Warnings, or Information tabsto display or hide the log types that you want to filter. Any combination of log types can be displayed bytoggling these tabs. When you change any of these tabs, the records that are displayed in the viewerare refreshed with the new filter options.

• 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 updatethe view.

– Filter on date range filters on a specified date range. Click Refresh to update the view.– Filter on Selection filters on selection job runs. Choose the selection that you want and click

Refresh. This option displays all log records associated with process IDs corresponding to theselected selection. This option can be combined with any other filter option.

– ProcessID filters on a specific process ID. Type the process ID in ProcessID and click Refresh. Thisoption 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 display an expanded window ofthe log record.

Procedure

1. 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 records to a text file.

Procedure

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

• To export all records in the log view, click Export, specify a file and path where the log records areto be exported.


• To export selected records in the log view, select the log records that you want, right-click and clickExport Selected Log Items, and specify a file and 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 Server selections from a commandline.

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

The Command Line Utility returns the following return codes:

• 1: Indicates an error• 0 (zero): Indicates that the process terminated normally

Interactive modeYou can use the IBM Cognos Integration Server Command Line Utility to run selections from a commandconsole.

Interactive Mode

To run the Command Line Utility in interactive mode, from the Start menu click IBM Cognos IntegrationServer > Command Line Utility.

Attention: The first time that you use the utility, you might have to click Command Line Utilitytwice to allow for the initialization to take place.

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

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

Table 6: 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 selection ID orname 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 of connectionID or name of connection name to the directoryname directory.

EXPORT_SELECTION_ALL directory name Exports all selections to the directory namedirectory.

EXPORT_SELECTION selection ID | selection namedirectory name

Exports the selection with the ID of selection ID orname of selection name to the directory namedirectory.

HELP Displays the online help.


Table 6: Command Line Utility interactive mode commands (continued)

Command Description

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

IMPORT_CONNECTION connection file name * Imports a previously exported connection from theconnection file name name.

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

Imports a previously exported selection from theselection file name name and assigns the sourceand target connections to it.

LIST Displays a list of all selections.

LIST selection ID Displays a list of all members of the selection withthe ID of selection ID.

LIST selection name Displays a list of all members of the selection withthe 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 or equalto Start ID and smaller than or equal to End ID.

RUN ALL selection ID1 selection ID2 ... selectionIDn

Runs all specified selections.

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

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 ID withextra input or modification commands from one ormore command files.

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

Runs the selection with the name of selection namewith extra input or modification commands fromone or more command files.


Table 6: Command Line Utility interactive mode commands (continued)

Command Description

RUN selection ID dimension member function[custom name]

Runs the selection with the ID of selection ID. If thedimension member member is selected in theselection, its function is updated. If the member isnot selected, it is added to the selection before it isrun. Use the custom name to change the name ofthe member 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 Integration ServerManager outline to see all valid functionsfor 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 is updated. Ifthe member is not selected, it is added to theselection before it is run. Use the custom name tochange the name of the member as it appears inthe output from the run.


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 Integration ServerManager outline to see all valid functionsfor that member.

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

Updates an existing selection with settings from apreviously exported selection file and optionallyassigns the source and target connection to it. Theselection keeps its original source and targetconnections if no source and target connectionsare specified.

RUNselection ID characteristicmemberMEMBER[custom name]

Runs the selection, adding the member to themember selection. The custom name is optional

The Command Line Utility supports the following SAP InfoCube-specific commands. Characteristic,hierarchy, and member names are the display names.


Table 7: Command Line Utility SAP InfoCube commands

Command Description

RUN selection ID characteristic member MEMBER[custom name]

Runs the selection, adding the member to themember selection.

The custom name is optional.

RUN selection ID characteristic member functionhierarchy

Runs the selection, adding the member to themember selection using the function provided.

The function can be: CHILDREN, ANCESTORS,LEVMBRS, or DESCENDANTS.

RUN selection ID characteristic hierarchy function Runs the selection adding, the hierarchy to themember selections using the specified function.

The function can be: LEVMBRS or DESCENDANTS.

RUN selection name characteristicmember MEMBER[custom name]



RUN selection name characteristicmember functionhierarchy


The function can be: CHILDREN, ANCESTORS,LEVMBRS, DESCENDANTS.

RUN selection name characteristic hierarchyfunction

Runs the selection, adding the hierarchy to themember selections using the specified function.


The Command Line Utility supports the following SAP InfoQuery specific commands. Variable,characteristic, and member names are the display names.

Table 8: Command Line Utility SAP InfoQuery commands

Command Description

RUN selection id characteristic member MEMBER[custom name]

Runs the selection adding the member to themember selection.


RUN selection id characteristic member CHILDREN Runs the selection, adding the member’s children.

RUN selection id SET_VARIABLE variable namevariable value

Runs the selection, setting the value to the queryvariable.

RUN selection name characteristic memberMEMBER [custom name]



RUN selection name characteristic memberCHILDREN

Runs the selection, adding the member’s children.

RUN selection name SET_VARIABLE variable namevariable value

Runs the selection, setting the value to the queryvariable


Attention: Parameter values, such as member names, selection names, command file names, andcustom names that contain spaces, must be enclosed in double quotation marks.

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

Batch modeYou can use the IBM Cognos Integration Server Command Line Utility to run selections from a batch fileas part of an automation process.

To run the Command Line Utility in batch mode, open a command prompt window and type C:\ProgramFiles(x86)\IBM\Cognos Integration Server\ICIS\startICISCMD.bat, followed by thecommand parameters, where C:\Program Files(x86)\IBM\Cognos Integration Server is theinstallation directory, or add the equivalent command to a batch file and run it.

The Command Line Utility in batch mode supports the following command parameters:

Table 9: Batch mode command parameters

Parameter Description

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

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 ID withextra input or modification commands from one ormore command files.

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

Runs the selection with the name of selection namewith extra input or modification commands fromone or more command files.

RUN selection ID dimension member function[custom name]

Runs the selection with the ID of selection ID. If thedimension member member is selected in theselection, its function is updated. If the member isnot selected, it is added to the selection before it isrun. Use the custom name to change the name ofthe member 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 validfor each member. Right-click a member inthe Integration Server Manager outline tosee all valid functions for that member.


Table 9: Batch mode command parameters (continued)


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 is updated. Ifthe member is not selected, it is added to theselection before it is run. Use the custom name tochange the name of the member as it appears inthe output from the run.


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

RUN ALL Runs all selections.

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

RUN ALL selection ID1 selection ID2 ... selectionIDn

Runs all specified selections.

DELETE_SELECTION_ALL * Deletes all selections.

DELETE_SELECTION_ALL * selection ID | selectionname *

Deletes the selection with the ID of selection ID orname of selection name.

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 of connectionID or name of connection name to the directoryname directory.

EXPORT_SELECTION_ALL directory name Exports all selections to the directory namedirectory.

EXPORT_SELECTION selection ID | selection namedirectory name

Exports the selection with the ID of selection ID orname of selection name to the directory namedirectory.

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

IMPORT_CONNECTION connection file name * Imports a previously exported connection from theconnection file name name.

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

Imports a previously exported selection from theconnection file name name and assigns the sourceand target connections to it.


Table 9: Batch mode command parameters (continued)


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

Updates an existing selection with settings from apreviously exported selection file and optionallyassigns the source and target connection to it. Theselection keeps its original source and targetconnections if no source and target connectionsare specified.

The Command Line Utility supports the following SAP InfoCube-specific commands. Characteristic,hierarchy, and member names are the display names.

Table 10: Command Line Utility SAP InfoCube commands

Command Description

RUN selection ID characteristic member MEMBER[custom name]



RUN selection ID characteristic member functionhierarchy



RUN selection ID characteristic hierarchy function Runs the selection adding, the hierarchy to themember selections using the specified function.


RUN selection name characteristicmember MEMBER[custom name]



RUN selection name characteristicmember functionhierarchy


The function can be: CHILDREN, ANCESTORS,LEVMBRS, DESCENDANTS.

RUN selection name characteristic hierarchyfunction

Runs the selection, adding the hierarchy to themember selections using the specified function.


The Command Line Utility supports the following SAP InfoQuery specific commands. Variable,characteristic, and member names are the display names.

Table 11: Command Line Utility SAP InfoQuery commands

Command Description

RUN selection id characteristic member MEMBER[custom name]

Runs the selection adding the member to themember selection.


RUN selection id characteristic member CHILDREN Runs the selection, adding the member’s children.


Table 11: Command Line Utility SAP InfoQuery commands (continued)

Command Description

RUN selection id SET_VARIABLE variable namevariable value

Runs the selection, setting the value to the queryvariable.

RUN selection name characteristic memberMEMBER [custom name]



RUN selection name characteristic memberCHILDREN

Runs the selection, adding the member’s children.

RUN selection name SET_VARIABLE variable namevariable value

Runs the selection, setting the value to the queryvariable



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 a semicolon (;) are consideredcomments and are ignored. For more information, see “Extraction options” on page 27.



The following table shows command file options that are available for all selection types:

Table 12: Command file options that are available for all selection types

Command syntax Description

CREATE_STAR_SCHEMA ON | OFF Turns creation of the metadata and data tables onor off.

For TM1 targets, use this option to turn cubecreation on and off.

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

DELETE_ALL Precision Deletes all selected members from the dimensiondimension from the selection before it is run. Thecommand is ignored if the dimension does notexist.

DELETE dimension member Deletes the dimension member member from theSelection before it is run. The command is ignoredif either the dimension or the member does notexist.

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


Table 12: Command file options that are available for all selection types (continued)


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

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

For TM1 targets, use this option to set the cubename.

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.

Not available for TM1 targets.

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.

For TM1 targets, use this option to set the cube anddimension prefix.

RECORD_COMMIT Record Commit Number Record Commit Number specifies the number ofextracted data records that are held in memorybefore they are committed to the targetconnection.

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 user name| source connection password [RDBMS connectionuser name | RDBMS connection password]]

The source connection that is used by thisselection. The source connection can be specifiedas the name of the connection or the ID of theconnection. The source connection name is thename that is shown in the Connection Managerconnection list.

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

Specify RDBMS connection user name and RDBMSconnection password to modify the RDBMS username and password of the connection. This onlyapplies to Planning connections.

User names and passwords are ignored if a sourceconnection does not require them.


Table 12: Command file options that are available for all selection types (continued)


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

The target connection that is used by thisselection. The target connection can be specifiedas the name of the connection or the ID of theconnection. The target connection name is thename that is shown in the Connection ManagerConnection List. Specify target connection username and target connection password] to modifythe user name and password of the connection.

User names and passwords are ignored if a targetconnection does not require them.

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

If the dimension member member is selected, itsfunction is updated. If the member is not selected,it is added to the Selection before it is run. Use thecustom name to change the name of the memberas it appears in the output from the run.

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

You can use EntityParentMember to specify theparent of an entity member. The default entityparent member is used if EntityParentMember isnot specified. To specify EntityParentMemberwithout setting a custom name, set custom nameto " " (a space that is enclosed in double quotationmarks).

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 validfor each member. Right-click a member inthe Integration Server Manager outline tosee all valid functions for that member.

UPDATE_COLUMNS dimension [dimension ...dimension]

Use this command to modify the export columnselections. For example:

UPDATE_COLUMNS Year, "Pkg Type", Measures

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

Year 0

Pkg Type 1

Measures 2

The following command file options are available for HFM selections:


Table 13: HFM command file options


DIMENSION_TABLE_LAYOUT PARENT_CHILD |BALANCED | QLIKVIEW | MDM member

This option determines the format of the metadatatables.

EXTRACT_HFM_CELL_TEXT ON | OFF Specifies that cell text is extracted from membersthat are selected in the Member Selectionswindow or that all cell text for the HFM applicationis extracted.

EXTRACT_HFM_CLID ON | OFF Specifies that cell line item details are extractedfrom members that are selected in the MemberSelections window, or that all cell line item detailsfor the HFM application are 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 for theHFM application is extracted.

EXTRACT_HFM_JE ON | OFF Specifies that journal entries are extracted frommembers that are selected in the MemberSelections window, or that all journal entries forthe HFM application are extracted.

INCLUDE_HFM_CELL_STATUS ON | OFF Extracts the cell status.

MDM_VERSION version The Master Data Manager version number for MDMmetadata exports.

SUPPRESS_HFM_ZEROS ON | OFF Specifies that intersection points with data valuesof zero (after rounding up to the specified dataprecision) are not extracted.

SUPPRESS_HFM_SEM ON | OFF Suppresses the extraction of duplicate EntityMember data intersection points from HFM wherethe Entity name and Parent name are the 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 from intersectionpoints from HFM where the Entity member'sparent is not the default entity parent.

The following command file options are available for Planning selections:

Table 14: 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.


The following command file options are for Essbase and Planning selections:

Table 15: Essbase and Planning command file options


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

Applies to Essbase and Planning. Specifies the sizeof the internal buffer. This setting is typically left atthe default of Auto. For more information, see theBuffer size section in “Data extraction options” onpage 34.

CUSTOM_DATA_VALUE_FILTER filter Limits the Essbase selection output that is basedon standard Essbase IF condition syntax. Onlyavailable for Essbase extraction type I. For moreinformation, see the Custom Data Value Filtersection in “Data extraction options” on page 34.

CUSTOM_SCOPE_CONTROL scope Applies to Essbase and Planning. Provides analternative way of entering member selectioncriteria in addition to the function provided by theSelection Manager. Not available for Essbaseextraction type II and type IV. For moreinformation, see the Custom Scope Control sectionin “Data extraction options” on page 34.

DIMENSION_TABLE_LAYOUT PARENT_CHILD |BALANCED | QLIKVIEW | MDM member

This option determines the format of the metadatatables.

EXTRACT_EXPANDEDFILTERS ON | OFF Turns extraction of expanded filters on or off.

EXTRACT_FILTERS ON | OFF Turns extraction of filters 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_THREADS AUTO, 1,2, 3, 4, 5 ,6, 7, 8,9, 10, 11, 12, 13, 14, 15, 16, 32, 64

Select this option to specify the maximum numberof extraction threads that are used during anextraction. This setting is typically left at its defaultof Auto. A higher number puts a higher load on theEssbase server during a data extraction. Setting theextraction threads to 1 loads the Essbase serverthe least, but can lengthen the data extractiontime. Only available for Essbase extraction type IIand type IV.

EXTRACTION_TYPE TYPE_I | TYPE_II | TYPE_III |TYPE_IV

Sets the extraction type. Essbase or Planning only.

IMPLICIT_SHARE_OVERRIDE OFF | GENMBRS |LEVMBRS | PARENTCHILD | UDA

Applies to Essbase and Planning. Applies only toEssbase extraction type I. For more information,see the Implicit Share Override section in “Dataextraction options” on page 34.

INTELLIGENT_EXTRACTION ON | OFF Applies to Essbase and Planning. Specifies thatonly data that is changed since the last extractionis extracted. For more information, see theIntelligent extraction section in “Oracle Essbasedata extraction” on page 4.


Table 15: Essbase and Planning command file options (continued)


LEVEL_0_OPTIMIZATION ON | OFF Applies to Essbase and Planning. Optimizes theSparse Discovery for selections with memberfunctions Select Members from here based onLevel and level = 0 (zero).

LOCK_DATABASE ON | OFF Applies to Essbase and Planning. Prevents updatesto the Essbase database during extraction. Onlyavailable for Essbase extraction type II and typeIV.

MAX_UDAS 1-64 Applies only to Essbase and Planning. Sets themaximum number of UDA columns in the Essbasedimension tables. For more information, see“Essbase dimension table” on page 110.

MDM_VERSION version The Master Data Manager version number for MDMmetadata exports.

SET_DATA_AS_CLEAN ON | OFF Sets the data blocks to Clean after the extraction.Available for Essbase extraction types I and III.

STORED_MEMBERS_ONLY ON | OFF Applies to Essbase and Planning. Specifies thatdynamic members are left out of the extraction.Available for Essbase extraction types I and III.

SUPPRESS_ESSBASE_MISSING ON | OFF Specifies that all intersection points that aredesignated #Missing or NULL are not extracted.

SUPPRESS_ESSBASE_ZERO ON | OFF Applies to Essbase and Planning. Specifies thatintersection points with data values of zero (afterrounding up to the specified data precision) are notextracted.

USE_ALIAS ON | OFF Applies to Essbase, Planning, and CognosIntegration Server star schema. Specifies thatmember aliases (rather than the member names)are extracted to the target connection FACT table.This option has no effect if the FACT TableMember Values option is set to Member ID. If youuse extraction type III and a text file target, theexported dimension values are member names.

The following command file options are available for Essbase, Planning, and HFM selections that use adimension table layout style of Balanced Hierarchy I:

Table 16: Essbase, Planning, and HFM Balanced Hierarchy I command file options


BH_I_FORMAT LEVEL | GENERATION For dimension table lay out styles of BalancedHierarchy I, specifies either generation format, inwhich metadata columns are ordered from the topdown, or level format, in which metadata columnsare ordered from the bottom up. For moreinformation, see the Extract Metadata section in“Metadata extraction options” on page 33.


Table 16: Essbase, Planning, and HFM Balanced Hierarchy I command file options (continued)


GENERATION_NAME Dimension (case sensitive)Generation GenerationName

Specifies a name for a dimension's generation.

The name is used as the column name in thebalanced hierarchy dimension table for thatdimension generation if BH_I_FORMAT is set toGENERATION.

LEVEL_NAME Dimension (case sensitive) LevelLevelName

Specifies a name for a dimension's level.

The name is used as the column name in thebalanced hierarchy dimension table for thatdimension level if BH_I_FORMAT is set to LEVEL.

The following command file options are available for SAP InfoCubes. Characteristic, hierarchy, andmember names are the display names.

Table 17: SAP InfoCube-specific commands


UPDATE_SAP_DISP characteristic memberMEMBER [custom name]

Adds the member to the member selection.


UPDATE_SAP_DISP characteristic memberfunction hierarchy

Adds the member to the member selection usingthe function provided.


UPDATE_SAP_DISP characteristic hierarchyfunction

Adds the hierarchy to the member selections usingthe specified function.


The following command file options are available for SAP InfoQueries. Variable, characteristic, andmember names are the display names.

Table 18: SAP InfoQuery-specific commands


UPDATE_SAP_DISP characteristic memberMEMBER [custom name]



UPDATE_SAP_DISP characteristic memberCHILDREN

Adds the member’s selected children.

UPDATE_SAP_DISP SET_VARIABLE variable namevariable value

Sets the value to the query variable.

The following command file options are available for SAP InfoCubes. Characteristic, hierarchy, andmember names are the technical names.


Table 19: SAP InfoCube-specific commands


UPDATE_SAP_TECH characteristic memberMEMBER [custom name]



UPDATE_SAP_TECH characteristic memberfunction hierarchy

Adds the member to the member selection usingthe function provided.


UPDATE_SAP_TECH characteristic hierarchyfunction

Adds the hierarchy to the member selections usingthe specified function.


The following command file options are available for SAP InfoQueries. Variable, characteristic, andmember names are the display names.

Table 20: SAP InfoQuery-specific commands


UPDATE_SAP_TECH characteristic memberMEMBER [custom name]



UPDATE_SAP_TECH characteristic memberCHILDREN

Adds the member’s selected children.

UPDATE_SAP_TECH SET_VARIABLE variable namevariable value

Sets the value to the query variable.

IBM Cognos Integration Server star schema definition

The star schemas that are created by the IBM Cognos Integration Server follow the typical format of asingle fact table and multiple dimension tables.

The star schema tables that are created by the Cognos Integration Server support Oracle EssbaseIntegration Services (EIS) in the form of structure and metadata content. The Oracle Essbase IntegrationServices use specific member attribute codes in dimension tables for building Oracle Essbase cubes.

When the Create Star Schema option is selected for selections that contain a relational targetconnection, a table is created for each dimension in the selection and one fact table that is called FACT iscreated to contain source connection data.

All tables that are created by the Cognos Integration Server are generic and can accommodate any type ofdata. As a result, the data types that are used are a standard varchar(255) data type for text and anumeric data type for numbers.

The Cognos Integration Server does not create indexes or relationships between the tables. After youcreate a star schema, you can modify the table definition of data types, indexes, and relationships.However, if you change these table properties, make sure that the metadata or data to be written to thesetables by the Cognos Integration Server can be accommodated. For example, do not delete fields that arecreated by the Cognos Integration Server. Also, do not modify the following parts of the table structure:

• Table names• Field names that are created by the Cognos Integration Server


Dimension tables that are created from Essbase and HFM source connections have different tablestructures under the parent-child hierarchy layout. However, there is no difference between Essbase andHFM source connections that use the Generations or Level format (translation table). The table definitionsfor the standard Parent-Child format are described first, followed by the definition of the Generations andLevel format.

Attention: All target star schemas must be in their own databases. The Integration Server doesnot support mixing target star schemas with other application database tables.

Star schema fundamentalsThe dimensional star schema is a relational schema in which a central fact table holds numerical data.

Joined to the fact table are dimension tables that hold the corresponding metadata. Metadata is dataabout data, and includes information such as hierarchal relationships and consolidation attributes.

Figure 8: A typical star schema

The Essbase outline, as shown in the following image, is a manifestation of a relational star schema in amultidimensional data storage system. A star schema is often referred to as a cube, even though it isstored in a relational database. The Essbase outline is an excellent visual representation of a cube and therelated hierarchies, attributes, and calculations. The following is an example of an Essbase outline. Thebackground text is deliberately blurred.

IBM Cognos Integration Server star schema definition 105

Figure 9: Essbase outline

Attention: A dimensional star schema is not required to build an Essbase outline, but adimensional star schema simplifies maintenance, especially if used with Oracle EssbaseIntegration Services (EIS).

In summary, the IBM Cognos Integration Server is designed to generate and maintain a dimensional starschema (data and metadata).

Attention: It is not necessary that the output target of the Cognos Integration Server is a relationalstar schema. The target can be a text file.

Parent-child formatIn the parent-child star schema format, the dimension tables have one record for each member in thedimension.

Each record specifies the member name, its related attribute, and its immediate parent. The hierarchyrelationship is implicitly represented recursively by the PARENT and CHILD fields. Because both Essbaseand HFM both do not allow duplicate member names, each record in a dimension table is unique, basedon the CHILD field.

Attention: Both Essbase and HFM use the Shared Member concept to support alternativehierarchies. In these cases, child members might be duplicated underneath a separate roll-upstructure with a storage attribute of SHARED.

Generation formatYou can use the Integration Server to create the star schema of a target connection in a Generationformat. In this format, each record in the dimension table reflects a level zero member and its ancestors,beginning from Generation One.

The fact table contains one column for each dimension that is selected in the respective selection, as inthe Parent-Child format. The difference is that the column name reflects the maximum Generationcolumn in the respective dimension table.

The Integration Server automatically balances ragged hierarchies that exist from either Essbase or HFM.The balancing is done by using the same member name in each of the Generation columns where ageneration does not exist. For example, if the Accounts dimension has a maximum of five generations, thecolumns in the Accounts dimension table is Generation1, Generation2, Generation3, Generation4 andGeneration5. If the Profit hierarchy in Accounts only goes to Generation2 with Sales and COGS as the onlydescendants of Profit, the records for the Profit hierarchy looks as follows:


Table 21:

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 HyperionIntelligence. The following tables illustrate the Generation format for dimension and fact tables.

Attention: Data type is given for SQL Server, DB2 / Oracle. For Unicode applications, thevarchar(xx) or varchar2(xx) columns are nvarchar(xx) or nvarchar2(xx).

Table 22: Generation format for dimensions

Column name Data type Description

Generation1 varchar(255) or varchar2(255) GENERATION1 is replaced withthe name of generation 1 that isspecified in the Translation tableof the selection. The valuesconsist of the member name atthat generation.

Generation2 varchar(255) or varchar2(255) GENERATION2 is replaced withthe name of generation 2 that isspecified in the Translation tableof the selection. The valuesconsist of the member name atthat generation.

Generationn varchar(255) or varchar2(255) GENERATIONn is replaced withthe name of the highestgeneration number of thedimension that is specified in theTranslation table of the selection.The values consist of the membername at that generation.

The column names, data types, and descriptions for the fact table.

Table 23: Generation format for fact tables


DIM1MAXGEN varchar(255) or varchar2(255) DIM1MAXGEN is replaced withthe name of the largestcorresponding dimensiongeneration that is specified in theTranslation table of the selection.The values consist of the membername at that generation.

DIM2MAXGEN varchar(255) or varchar2(255) DIM2MAXGEN is replaced withthe name of the largestcorresponding dimensiongeneration that is specified in theTranslation table of the selection.The values consist of the membername at that generation.


Table 23: Generation format for fact tables (continued)


DIMnMAXGEN varchar(255)/ or archar2(255) DIMnMAXGEN is replaced withthe name of the largestcorresponding dimensiongeneration that is specified in theTranslation table of the selection.The values consist of the membername at that generation.

DATA numeric(14,x) or number(14,x) Actual data value of thedimension member intersection.The precision of this field (x) isbased on the Data Precisionoption of the selection that isused to create the table.

STATUS varchar(100) or varchar2(100) Used only in the HFM fact table.STATUS is used to display theHFM data intersection status thatis provided by HFM.

Level formatYou can use the IBM Cognos Integration Server to create the star schema of a target connection in levelformat.

In level format, each record in the dimension table reflects a level-zero member and its ancestors,beginning from the top level on its drill path. The fact table contains one column for each dimension thatis selected in the respective selection, as in the parent-child format. The difference is that the columnname reflects the level 0 column in the respective dimension table.

The Cognos Integration Server automatically balances ragged hierarchies that exist from either Essbase,Planning, or HFM. The balancing is done by using the member name from the top level in each of the levelcolumns where a level does not 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 the inventory membername. The following example shows the level format in tree form:

Profit Margin Sales Cost of Goods Sold Total Expenses Marketing Payroll MiscellaneousInventory Opening Inventory Additions Ending InventoryRatios Margin Profit Profit per Ounce

The following shows the level format in table form:


Table 24: 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 by using the translation table,similar to the generation format.

Master data management formatMaster Data Management format is a specific format of Essbase and HFM metadata extraction thatsatisfies the importation requirements of Hyperion Master Data Management Server.

The format is:Action

Add or ChangePropMDM Version

Based upon setting in selection - for example, UATHierarchy

App Name, DB name, and dimensionNode

Parent Member (if ADD) or Child Member (if CHANGEPROP)Property

Child Member (if ADD) or PropertyName (if CHANGEPROP) - Note that PropertyName can be anyproperty established in MDM

Value0 (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 Unicode applications, thevarchar(xx) or varchar2(xx) data types are nvarchar(xx) or nvarchar2(xx).

The Essbase dimension table has the following columns with the following descriptions and data types:

IDPrimary key field.integer or int

DIMNAMEName of the respective dimension.varchar(255) or varchar2(255)

PARENTParent member name to the current member.varchar(255) or varchar2(255)

CHILDMember name.varchar(255) or varchar2(255)

ALIAS1 - ALIAS10Up to 10 alias names. ALIAS1 is typically from the Default Alias Table. ALIAS2 is typically from analternative Alias Table.varchar(255) or varchar2(255)

CONSOLIDATIONAggregation specifications with the outline. The following values are possible:

• +• -• *• /• %• ~

varchar(255) or varchar2(255)DATASTORE

Data storage types, as stored within Essbase. The following values are possible:

• S (stored)• N (never share)• O (label only)• SHARED (shared)• V (dynamic calc)• X (dynamic calc and store)

varchar(255) or varchar2(255)


TIMEBALANCEEssbase time balance specifications, as defined in the Essbase outline. The following values arepossible:

• N (none)• F (first)• L (last)• A (average)

varchar(255) or varchar2(255)SKIP

Essbase time balance skip specifications, as defined in the Essbase outline. The following values arepossible:

• N (none)• M (skip missing)• Z (skip zeros)• B (skip missing and zeros)

varchar(255) or varchar2(255)VARIANCE

Essbase variance specifications, as defined in the Essbase outline. The following values are possible:

• E (expense)• N (non-expense)

varchar(255) or varchar2(255)TWOPASSCALC

Essbase two-pass calc specifications, as defined in the Essbase outline. The following values arepossible:

• T (two-pass calc member)• N (no two-pass calc)

varchar(255) or varchar2(255)UDA1 - UDAn

User-defined attributes. 1 - 64 columns. For more information, see “Star schema options” on page 28.varchar(255) or varchar2(255)

ATTR_ASSOC1 - ATTR_ASSOC10Essbase attribute 1 - 10.varchar(255) or varchar2(255)

FORMULAEssbase member formula that is attached to the current member.varchar(xx) or varchar2(xx)The maximum size of the FORMULA column:

• SQL Server, non-unicode: 4000• SQL Server, Unicode: 2000• Oracle, non-unicode: 4000• Oracle, Unicode: 2000• DB2, Unicode, and non-unicode: 2000

MBRCOMMENTEssbase member comment that is assigned to the current member.varchar(255) or varchar2(255)


CUSTOM_NAMEUser-defined custom name.varchar(255) or varchar2(255)

GENERATIONEssbase member generation.varchar(255) or varchar2(255)

LEVELEssbase member level.varchar(255) or varchar2(255)

SOVLE_ORDERSolve order.varchar(255) or varchar2(255)

HFM accounts dimension tableYou can view the column names and data types for the Hyperion Financial Management (HFM) accountsdimension 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 following descriptions and datatypes:


DIMENSIONName of the respective dimension.varchar(255) or varchar2(255)


PARENTIDParent member ID assigned to the current member.int or number

CHILDCurrent member name.varchar(255) or varchar2(255)

AGGREGATIONAggregation specification symbols for the current member. The following values are possible:

• +• -• ~ (no aggregation)

varchar(5) or varchar2(5)CUSTOM_NAME

User-defined custom name.varchar(255) or varchar2(255)

DESCRIPTIONCurrent member description.


varchar(8000) or varchar2 (8000)UNIQUE_ALIAS

Unique alias for the current member.varchar(255) or varchar2(255)

DATA_STORAGEData storage type, as stored within HFM. The following values are possible:

• SHARED• NEVER SHARE• STORE

varchar(255) or varchar2(255)ITEM_LEVEL

Member level.varchar(255) or varchar2(255)

ITEM_GENERATIONMember generation.varchar(255) or varchar2(255)

ACCOUNT_TYPE_1HFM account type specification. The following values are possible:

• ASSET• BALANCE• CURRENCYRATE• DYNAMIC• EXPENSE• FLOW• GROUPLABEL• INCOME• LIABILITY• NONFINANCIAL• SYSTEM• TEXT• REVENUE

varchar(255) or varchar2(255)ACCOUNT_TYPE

Essbase equivalent HFM account type specification. The following values are possible:

• PL (profit or loss)• BS (balance sheet)• STAT (statistical account)

varchar(255) or varchar2(255)TIME_BALANCE

HFM time balance specification. The following values are possible:

• TB LAST• TB NONE



VARIANCE_REPORTINGHFM variance reporting specification. The following values are possible:

• NON-EXPENSE• EXPENSE

varchar(255) or varchar2(255)ISCALCULATED

Whether the data for an account is calculated by HFM. The following values are possible:

• True (calculated by HFM)• False (manually entered)

varchar(255) or varchar2(255)ISCONSOLIDATED

Whether the data for an account is consolidated to parent entities. The following values are possible:

• True (consolidated to parent entities)• False (not consolidated to parent entities)

varchar(255) or varchar2(255)ISICP

Whether the account is used in intercompany transactions. The following values are possible:

• Y (yes)• N (no)

varchar(255) or varchar2(255)PLUGACCT

The member ID of the account's plug account.varchar(255) or varchar2(255)

CUSTOM1TOPMEMEBERFirst account type attribute assigned to the current member.varchar(255) or varchar2(255)

CUSTOM2TOPMEMBERSecond account type attribute assigned to the current member.varchar(255) or varchar2(255)

CUSTOM3TOPMEMBERThird account type attribute assigned to the current member.varchar(255) or varchar2(255)

CUSTOM4TOPMEMBERFourth account type attribute assigned to the current member.varchar(255) or varchar2(255)

NUMDECIMALPLACESThe maximum number of digits after the decimal point that the account supports.varchar(255) or varchar2(255)

USESLINEITEMSWhether the account allow line items. The following values are possible:

• True (allowed)• False (not allowed)

varchar(255) or varchar2(255)ENABLECUSTOM1AGGR

Whether the EnableCustom1Aggr attribute is enabled. The following values are possible:


• True (enabled)• False (attribute is disabled)










varchar(255) or varchar2(255)USERDEFINED1

The UserDefined1 attribute for the account.varchar(255) or varchar2(255)

USERDEFINED2The UserDefined2 attribute for the account.varchar(255) or varchar2(255)


XBRLTAGSThe XBRL Tags attribute for the account.varchar(255) or varchar2(255)

SECURITYCLASSThe ID of the security class that is assigned to the account.varchar(255) or varchar2(255)

ICPTOPMEMBERThe member ID of the Intercompany Partner dimension member that is assigned as an accountdimension member's ICPTopMember attribute.varchar(255) or varchar2(255)

ENABLEDATAAUDITWhether the ENABLEDATAAUDIT attribute is enabled. The following values are possible:

• True (enabled)• False (not enabled)

Attention: For HFM 3.5.1, this attribute is not supported and is set to False.



DEFAULTPARENTThe name of the default parent.varchar(255) or varchar2(255)

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 Financial Management (HFM) entitydimension table


The HFM entity dimension table has the following columns with the following descriptions and data types:



PARENTParent member name that is assigned to the current member.varchar(255) or varchar2(255)



AGGREGATIONAggregation specification symbol for the current member. The following values are possible:




DESCRIPTIONCurrent member description.varchar(8000) or varchar2(8000)


UNIQUE_ALIASUnique alias for the current member.varchar(255) or varchar2(255)

DATA_STORAGEData storage type as stored within HFM. The following values are possible:





DEFCURRENCYThe member ID of the Value dimension member that represents the entity's default currency.varchar(255) or varchar2(255)

ALLOWADJSWhether the entity allows journal entries. The following values are possible:

• True (journal entries are allowed)• False (journal entries are not allowed)

varchar(255) or varchar2(255)ISICP

Whether the entity is used in intercompany transactions. The following values are possible:

• Y (yes)• N (no)

varchar(255) or varchar2(255)ALLOWADJFROMCHILDREN

Whether the entity allows journal postings from its children. The following values are possible:

• True (journal postings from children are allowed)• False (journal postings from children are not allowed)

varchar(255) or varchar2(255)SECURITYCLASS

The ID of the security class that is assigned to the entity.varchar(255) or varchar2(255)

USERDEFINED1The value that is defined for the entity's UserDefined1 attribute.varchar(255) or varchar2(255)




HOLDINGCOMPANYThe name of the HoldingCompany attribute.varchar(255) or varchar2(255)

HOLDINGCOMPANYIDThe ID of the HoldingCompany attribute.int or number

SECURITYASPARTNERThe name of the SecurityAsPartner attribute.varchar(255) or varchar2(255)

SECURITYASPARTNERIDThe ID of the SecurityAsPartner attribute.int or number

ORGBYPERIODFILTERINGONWhether the entity has organization by period filtering enabled. The following values are possible:


varchar(255) or varchar2(255)DEFAULTPARENT

The name of the default parent.varchar(255) or varchar2(255)




HFM scenario dimension tableYou can view the column names and data types for the Hyperion Financial Management (HFM) scenariodimension table.


The HFM scenario dimension table has the following columns with the following descriptions and datatypes:


















DEFAULTFREQThe ID number of the scenario dimension member's default frequency.varchar(255) or varchar2(255)

DEFAULTVIEWThe number that identifies the default view of the scenario dimension member.varchar(255) or varchar2(255)

ZEROVIEWFORNONADJThe member ID of the view dimension member that is assigned as the ZeroViewForNonadj attribute.varchar(255) or varchar2(255)

ZEROVIEWFORADJThe member ID of the View dimension member that is assigned as the ZeroViewForAdj attribute.varchar(255) or varchar2(255)


CONSOLIDATEYTDWhether the Scenario dimension member supports year-to-date consolidation. The following valuesare possible:

• True (supported)• False (not supported)


The value that is defined for the entity's UserDefined1 attribute.varchar(255) or varchar2(255)



SUPPORTPROCESSMANAGEMENTWhether the process management feature is enabled. The following values are possible:


varchar(255) or varchar2(255)SECURITYCLASS

The ID of the assigned security class.varchar(255) or varchar2(255)

MAXIMUMREVIEWLEVELThe value that is assigned to the MaximumReviewLevel attribute.varchar(255) or varchar2(255)

USESLINEITEMSWhether the Scenario dimension member supports line items. The following values are possible:

• True (supports)• False (does not support)

varchar(255) or varchar2(255)ENABLEDATAAUDIT

Whether the data audit attribute is enabled. The following values are possible:


Attention: For HFM 3.5.1, this attribute is not supported and is set to False.

varchar(255) or varchar2(255)DEFFREQFORICTRANS

DefFreqForICTrans attribute.

Attention: For HFM 3.5.1, this attribute is not supported and is set to 0.

varchar(255) or varchar2(255)DEFAULTPARENT

The name of the default parent.


varchar(255) or varchar2(255)DEFAULTPARENTID

The ID of the default parent.int or number



HFM year dimension tableYou can view the column names and data types for the Hyperion Financial Management (HFM) yeardimension table.


The HFM year dimension table has the following columns with the following descriptions and data types:











UNIQUE_ALIASUnique alias for the current member.


varchar(255) or varchar2(255)DATA_STORAGE

Data storage type, as stored within HFM. The following values are possible:





YEARRANGE_FIRSTThe first year in the range of valid years.varchar(255) or varchar2(255)

YEARRANGE_LASTThe last year in the range of valid years.varchar(255) or varchar2(255)



HFM period dimension tableYou can view the column names and data types for the Hyperion Financial Management (HFM) perioddimension table.


The HFM period dimension table has the following columns with the following descriptions and datatypes:


















BASEFREQUENCYThe ID of the base frequency for the application.int or number

FREQUENCYThe ordinal position of a period within the base frequency for the application.varchar(255) or varchar2(255)




HFM ICP dimension tableYou can view the column names and data types for the Hyperion Financial Management (HFM) ICPdimension table.


The HFM ICP dimension table has the following columns with the following descriptions and data types:


















SECURITYCLASSThe ID of the security class that is assigned to the Intercompany Partner.varchar(255) or varchar2(255)

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 Financial Management (HFM) custom1-4 dimension table.


The HFM custom1- 4 dimension table has the following columns with the following descriptions and datatypes:












varchar(8000) or varchar2 (8000)UNIQUE_ALIAS







ISCALCULATEDWhether the data for the Custom member is calculated by HFM. The following values are possible:

• True (calculated by HFM)• False (data is manually entered)

varchar(255) or varchar2(255)SWITCHSIGNFORFLOW

Whether the Switchsignforflow attribute for the Custom dimension member is enabled. The followingvalues are possible:


varchar(255) or varchar2(255)SWITCHTYPEFORFLOW

Whether the Switchtypeforflow attribute for the Custom dimension member is enabled. The followingvalues are possible:



The UserDefined1 attribute for the account.varchar(255) or varchar2(255)



SECURITYCLASSThe ID of the security class.int or number


DEFAULTPARENTThe name of the default parent.varchar(255) or varchar2(255)




HFM view and value dimension tablesYou can view the column names and data types for the Hyperion Financial Management (HFM) view andvalue dimension tables.


The HFM view and value dimension tables have the following columns with the following descriptions anddata types:




PARENTIDParent member ID that is assigned to the current member.int or number








varchar(8000) or varchar2(8000)UNIQUE_ALIAS









Essbase and HFM narrow fact tableYou can view the column names and data types for the Essbase and Hyperion Financial Management(HFM) narrow fact table.

The data type is listed for SQL Server, DB2, and Oracle data targets. For Unicode applications, thevarchar(xx) or varchar2(xx) columns have the data type nvarchar(xx) or nvarchar2(xx).

The order of the DIMNAME1 - DIMNAMEn columns is determined by the Sort column value of the ColumnSelections window.

The Essbase and HFM narrow fact table has the following columns with the following descriptions anddata types:DIMNAME1 - DIMNAMEn

DIMNAME1 - DIMNAMEn is the name of the columns 1 - n that are selected to be exported.If Use Member Names is selected, the column values are member names that correspond to theCHILD field of the respective dimension table.If Use Member ID Reference is selected, the column values are the IDs that correspond to the IDfield of the respective dimension table.varchar(255) or varchar2(255) or int or numberThe data type depends on the Fact Table Member Values setting. For more information, see “Starschema options” on page 28.

DATAContains the actual data value of the dimension member intersection. The precision of this field (x) isbased on the Data Precision option of the Selection 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 status that is provided by HFM. Thefollowing cell status values are possible:

• OK (OK)• Locked (locked)• OK SC (OK but system changed)• CH (needs chart logic)• TR (needs translation)• CN (needs consolidation)

varchar(100) or varchar2(100)AUDITID

When a data extraction is run, either from HFM or in Essbase, the Integration Server adds or updatesthe AUDITID field in the fact table. The AUDITID references a record in the fact audit table. This tablehas the same 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 Hyperion Financial Management(HFM) wide fact table.


The ordering of the DIMNAME1 - DIMNAMEn columns is determined by the Sort column value of theColumn Selections window.

The Essbase and HFM wide fact table has the following columns with the following descriptions and datatypes:DIMNAME1 - DIMNAMEn

DIMNAME1 - DIMNAMEn are the names of the columns 1 - n that are selected to be exported. Thecolumn values are member names that correspond to the CHILD field of the respective dimensiontable.varchar(255) or varchar2(255)

WideMember1 - WideMembernWideMember1 - WideMembern are the names of the 1 - n Wide dimension member columns. Thecolumn values are the actual data values of the dimension member intersection. The precision ofthese fields (x) is based on the Data Precision option of the Selection 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 status that is provided by HFM. Thefollowing cell status values are possible:

• OK (OK)• Locked (locked)• OK SC (OK but system changed)• CH (needs chart logic)• TR (needs translation)• CN (needs consolidation)



AUDITIDWhen a data extraction is run, either from HFM or in Essbase, the Integration Server adds or updatesthe AUDITID field in the fact table. The AUDITID references a record in the fact audit table. This tablehas the same 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 “Star schema options” on page28.

Planning account annotations fact tableYou can view the column names and data types for the Planning account annotations fact table.


The Planning account annotations fact table has the following columns with the following descriptionsand data types:

DATABASEThe name of the planning database.varchar(80) or varchar2(80)

SCENARIOSThe Scenario dimension member.varchar(80) or varchar2(80)

VERSIONSThe Scenario version.varchar(80) or varchar2(80)

ENTITIESThe Entity dimension number.varchar(80) or varchar2(80)

ACCOUNTSThe Account dimension number.varchar(80) or varchar2(80)

DESCRIPTIONThe description for the account.varchar(2000) or varchar2(2000)

AUDITIDThe AUDITID references a record in the fact audit table. This table has the same name as the facttable, 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 fact table.


The Planning cell text fact table has the following columns with the following descriptions and data types:

DATABASEName of the planning database.varchar(40) or varchar2(40)


TEXTCell note contents.varchar(2000) or varchar2(2000)

<dimensions>One field for each dimension with cell text.varchar(80) or varchar2(80)

NOTE_IDID of the cell note.int or number


Planning form annotations fact tableYou can view the column names and data types for the Planning form annotations fact table.


The Planning form annotations fact table has the following columns with the following descriptions anddata types:


FORMName of the form.varchar(80) or varchar2(80)

FORM_IDID of the form.int or number

TITLEThe form title.varchar(40) or varchar2(40)

TEXTThe contents of the annotations.varchar(2000) or varchar2(2000)

ANNOT_SEQAnnotation sequence identifier.int or number

CREATEDCreation time and date.datetime or date

AUTHORThe name of the author of the annotation.varchar(80) or varchar2(80)

AUTHOR_IDID of the author of the annotation.


int or numberAUDITID

The AUDITID references a record in the fact audit table. This table has the same name as the facttable, plus a suffix of _AUDIT.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 following descriptions and data types:

PLANNING_UNITName of the planning unit.varchar(80) or varchar2(80)

PLANNING_UNIT_IDID of the planning unit.int or number

TITLEPlanning unit title.varchar(40) or varchar2(40)

TEXTPlanning unit contents.varchar(2000) or varchar2(2000)

SCENARIOPlanning unit scenario member.varchar(80) or varchar2(80)

VERSIONName of the version.varchar(80) or varchar2(80)

ENTITYPlanning unit Entity member.varchar(80) or varchar2(80)

ANNOT_SEQPlanning unit annotation sequence number.integer or int

CREATEDCreation time and date.datetime or date

AUTHORThe name of the author.varchar(80) or varchar2(80)

AUTHOR_IDID of the author.int or number



Planning supporting details fact tableYou can view the column names and data types for the Planning supporting details fact table.


The Planning supporting details fact table has the following columns with the following descriptions anddata types:


DETAIL_DESCRIPTIONSupporting detail label.varchar(255) or varchar2(1500)

OPERATOROperator that is associated with detail. The following values are possible:

• 0 (ignore)• 1 (add)• 2 (subtract)• 3 (multiply)• 4 (divide)

char or charPOSITION

Position 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.varchar(80) or varchar2(80)

DETAIL_IDDetail identifier.int or number



Audit tableThe AUDITID field in the fact Table references the AUDITID field in the Audit Table. The Audit table alwayshas the same name as the fact table with the addition of the suffix _AUDIT.


The Audit table has the following columns with the following descriptions and data 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 audit record.varchar(500) or varchar2(500)

RecordDateDate and time the data extraction that is completed and the audit record was written.DateTime or Date

SourceConnectionIDConnection ID for the source connection that is used in the Selection that created the audit record.int or number

SourceConnectionConnection name for the source connection that is used in the Selection that created the audit record.varchar(500) or varchar2(500)

LoadTypeLoad type that is used based on the Selection. The following values are possible:

• Refresh• Append• Merge

varchar(25) or varchar2(25)SavedSelection

Binary representation of the Selection state at the time the Selection was run.image or blob

Essbase filters tablesOracle Essbase filters can be extracted in both Essbase and Planning formats. The formats are supportedby the Integration Server to facilitate importing filters into Oracle Essbase or Hyperion Planning using therespective Hyperion utilities.

Both formats contain one row of filter data for each unique combination of a filter row assigned to anEssbase Application, Database and User.


The Essbase filter table has the following columns with the following descriptions and data types:


FilterNameThe name of the filter.varchar(50) or varchar2(50)

EsbApplicationOracle Essbase application name that the filter belongs to.varchar(50) or varchar2(50)

EsbDatabaseOracle Essbase database name that the filter belongs to.varchar(50) or varchar2(50)

UserNameOracle Essbase user that the filter is assigned to.varchar(50) or varchar2(150)

EsbFilterFilter Member Specification as defined in Oracle Essbase for the respective filter row.varchar(xx) or varchar2(xx)

Tip: For unicode applications, this columns is a maximum of 2000 characters.

AccessAccess level granted to the EsbFilter. The following values for the field are possible:

• Read• Write• None• MetaRead


The Planning filter table has the following columns with the following descriptions and data types:





EsbMemberOracle Essbase member that the Access and EsbFunction is applied to for the current filter row.varchar(100) or varchar2(100)




varchar(50) or varchar2(50)EsbFunction

Oracle Essbase member expansion function that is applied to the EsbMember value for the currentfilter row. For example, @CHILDREN is a possible value for this field. This value grants the levelspecified in Access to the children of the EsbMember value.varchar(50) or varchar2(50)

The Expanded filter table has the following columns with the following descriptions and data types:





EsbMemberOracle Essbase member that the Access and EsbFunction is applied to for the current filter row.varchar(100) or varchar2(100)



varchar(50) or varchar2(50)EsbFunction

Oracle Essbase member expansion function that is applied to the EsbMember value for the currentfilter row. For example, @CHILDREN is a possible value for this field. This value grants the levelspecified in Access to the children of the EsbMember value.varchar(50) or varchar2(50)

Essbase users tablesThe Essbase users metadata is extracted into two separate tables. The first table is a simple list ofusernames. The second table is a list of usernames and their respective user groups.


The Essbase users table has the following column names with the following descriptions and data types:

UserNameName of user.varchar(70) or varchar2(70)

UserTypeADMINISTRATOR or USER


varchar(15) or varchar2(15)Application

Name of the application that the user has access to.varchar(70) or varchar2(70)

DatabaseName of the database that the user has access to.varchar(70) or varchar2(70)

AccessThe user's access rights to the application or database. The following values are possible:

• N (none)• 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 following descriptions and data types:

UserGroupName of a security group as specified in the Oracle Essbase.varchar(150) or varchar2(150)

UserNameUsername as specified in the Oracle Essbase.varchar(150) or varchar2(150)

HFM process management fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) processmanagement fact table.


The HFM process management fact table has the following columns with the following descriptions anddata types:

ScenarioThe Scenario dimension member name of the process unit.varchar(255) or varchar2(255)

YearThe Year dimension member name of the process unit.varchar(255) or varchar2(255)

PeriodThe Period dimension member name of the process unit.varchar(255) or varchar2(255)

EntityThe Entity dimension member name of the process unit.varchar(255) or varchar2(255)

EntityParentThe Entity Parent dimension member name of the process unit.


varchar(255) or varchar2(255)Value

The Value dimension member name of the process unit.varchar(255) or varchar2(255)

TimeThe time of the process level change.datetime and date

UserThe name of the user that made the process level change.varchar(255) or varchar2(255)

ActionThe action taken.varchar(255) or varchar2(255)

StateThe process unit state after the process level change.varchar(255) or varchar2(255)

CommentsAny comments added to the process level change.varchar(4000) or varchar2(2400)


HFM journal items fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) journalitems fact table.


The order of the DIMNAME1 - DIMNAMEn columns is determined by the Sort column value of the ColumnSelection window.

The HFM journal items fact table has the following columns with the following descriptions and datatypes:

DIMNAME1 - DIMNAMEnDIMNAME1 - DIMNAMEn is the name of the columns 1 - n selected to be exported. If Use MemberNames is selected, the column values are member names that correspond to the CHILD field of therespective 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 numberThe data type depends on the setting for the Fact Table Member Values option. For more information,see “Star schema options” on page 28.

JOURNAL_IDThe journal ID uniquely identifies the journal.int or number

JOURNAL_LABELThe name of the journal.varchar(20) or varchar2(20)


JOURNAL_DATAThe data in the cell's journal entry. The precision of this field (x) is based on the Data Precision optionof the Selection used to create the table.numeric(14,x) or number(14,x)

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 are possible:

• C (credit item)• D (debit item)

varchar(1) or varchar2(1)DESCRIPTION

The description of the journal item.varchar(50) or varchar2(50)


HFM journals fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) journalsfact table.


For the PERIOD, VALUE, SINGLE_ENTITY, and SINGLE_PARENT columns in the table, the data typedepends on the value that you select for the Fact Table Member Values setting.

• If the Use Member Names value is selected, the data type is varchar(255) or varchar2(255).• 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 28.

The HFM journals fact table has the following columns with the following descriptions and data types:

JOURNAL_IDThe journal ID uniquely identifies the journal.int or number

JOURNAL_LABELName of the journal.varchar(20) or varchar2(20)

TYPEType of the journal. The following values are possible:

• ARL (auto-reversal)• ARV (auto-reversing)• REG (regular)

varchar(3) or varchar2(3)STATUS

Status of the journal. The following values are possible:


• A (approved)• P (posted)• R (rejected)• S (submitted)• W (working)

varchar(1) or varchar2(1)BALANCE_TYPE

Balance type of the journal. The following values are possible:

• B (balanced)• E (balanced by entity)• U (unbalanced)

varchar(1) or varchar2(1)JOURNAL_GROUP

The name of the group the journal has been assigned to if the journal is assigned to a group.varchar(30) or varchar2(30)

DESCRIPTIONA description of the journal.varchar(255) or varchar2(255)

PERIODThe journal's period dimension.varchar(255) or varchar2(255) or int or numberThe data type depends on the Fact Table Member Values setting that is selected.

VALUEThe journal's value dimension.varchar(255) or varchar2(255) or int or number

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 journalvarchar(255) or varchar2(255) or int or numberThe data type depends on the Fact Table Member Values setting that is selected.

SINGLE_PARENTThe journal's entity parent dimension if journal is a single entity journal.varchar(255) or varchar2(255) or int or numberThe data type depends on the Fact Table Member Values setting that is selected.

CREATED_USERName of user that created the journal.varchar(64) or varchar2(64)

POSTED_USERName of user that posted the journal.varchar(64) or varchar2(64)

APPROVED_USERName of user that approved the journal.varchar(64) or varchar2(64)


CREATED_DATE_TIMEDate the journal was created.varchar(255) or varchar2(255)

POSTED_DATE_TIMEDate the journal was posted.varchar(255) or varchar2(255)

APPROVED_DATE_TIMEDate the journal was approved.varchar(255) or varchar2(255)


HFM cell line item details fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) cell lineitem details fact table.



The HFM cell line item details fact table has the following columns with the following descriptions anddata types:


DATAContains the line item data. The precision of this field (x) is based on the Data Precision option of theSelection used to create the table.numeric(14,x) or number(14,x)

DESCRIPTIONThe description of the journal item.varchar(80) or varchar2(80)


HFM cell text fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) cell textfact table.




The HFM cell text fact table has the following columns with the following descriptions and data types:


TEXTThe cell text.varchar(4000) or varchar2(4000)

DESCRIPTIONThe description of the journal item.varchar(80) or varchar2(80)

AUDITIDThe AUDITID references a record in the fact audit table. This table has the same name as the facttable, plus the suffix _AUDIT.int or number

HFM cell history fact tableYou can view the column names and data types for the Hyperion Financial Management (HFM) cell historyfact table.



The HFM cell history fact table has the following columns with the following descriptions and data types:


SERVERThe name of the application server on which the data change was made.varchar(100) or varchar2(100)

USERNAMEName of the user who made the change.varchar(64) or varchar2(64)

TIME_MODIFIEDTime and date the change was made.DateTime Date


ACTIVITYThe change activity. The following values are possible:

• ALLOCATE• CELL_LOGIC• CHART_LOGIC• CONSOLIDATION• CUSTOM_LOGIC• DATA_CLEAR• DATA_COPY• DATA_ENTRY• DATA_EXTRACT• DATA_EXTRACT_HAL• DATA_LOAD• DATA_RETRIEVAL• IDLE• JOURNAL_ENTRY• JOURNAL_POSTING• JOURNAL_RETRIEVAL• JOURNAL_TEMPLATE_ENTRY• JOURNAL_UNPOSTING• LOGOFF• LOGON• LOGON_FAILURE• MEMBER_LIST_EXTRACT• MEMBER_LIST_LOAD• MEMBER_LIST_SCAN• METADATA_EXTRACT• METADATA_LOAD• RULES_EXTRACT• RULES_LOAD• RULES_SCAN• SECURITY_EXTRACT• SECURITY_LOAD• SECURITY_SCAN• TRANSLATION

varchar(40) or varchar2(40)VALUE

Contains the cell values that the data changes resulted in. The precision of this field (x) is based onthe Data Precision option of the Selection used to create the table.numeric(14,x) or number(14,x)

AUDITIDThe AUDITID references a record in the fact audit table. This table has the same name as the facttable, plus the suffix _AUDIT.int or number


SAP BW metadata tableThe metadata tables for InfoCubes and InfoQueries have one row for each SAP member.

SAP InfoCube tables also have one row for each hierarchy. These rows form a tree structure, the rootbeing the first row of the table that holds the names of the attributes for SAP InfoCube metadata tables. Adescription of the columns in the SAP BW metadata table follows:

IDA numeric ID generated by Cognos Integration Server.

DIMNAMEThe name of the characteristic.

HRYNAMEFor InfoCube tables, the technical name of the hierarchy.For InfoQuery tables, the technical name of the characteristic.

PARENTThe SAP technical name of the member's parent.

CHILDThe SAP technical name of the member.

CAPTIONThe SAP caption of the member.

CUSTOM_NAMEThe custom name of the member.

CUSTOM_TECH_NAMEThe custom technical name of the member.

CUSTOM_PARENT_TECH_NAMEThe custom technical name of the member's parent.

LEVELThe Cognos Integration Server level of the member.Level numbering starts from the leaf members. The leaf members are level 0.

GENERATIONThe Cognos Integration Server generation of the member.Generation numbering starts from the characteristic node, which is level 1.

ATTR_ASSOC_XX represents a number.These columns hold the attributes for each member. The names of the attributes are found on the firstrow of the table. If a member does not have a value for an attribute, this column is NULL.

TM1 dimension tableYou can view the column names and data types for the TM1 dimension table.


For Unicode applications, the varchar(xx) or varchar2(xx) data types are nvarchar(xx) or nvarchar2(xx).

The TM1 dimension table has the following columns with the following descriptions and data types:


DIMNAMEName of the respective dimension.


varchar(255) or varchar2(255)PARENT

Parent member name to the current member.varchar(255) or varchar2(255)

CHILDMember name.varchar(255) or varchar2(255)

ELEMENTTYPECan be 'Numeric', 'String', or 'Consolidated'.varchar(255) or varchar2(255)

WEIGHTNumerical value representing the weight of the element.varchar(255) or varchar2(255)

ALIAS1 - ALIASNVariable number of columns representing the aliases for an element.varchar(255) or varchar2(255)

ATTR_ASSOC1 - ATTR_ASSOCNVariable number of columns representing the attributes for an element.varchar(255) or varchar2(255)

LEVELNumerical value representing the level for an element. Level '0' value represents a leaf member.varchar(255) or varchar2(255)

TM1 fact tableYou can view the column names and data types for the TM1 dimension table.


For Unicode applications, the varchar(xx) or varchar2(xx) columns have the data type nvarchar(xx) ornvarchar2(xx).

The order of the DIMNAME1 - DIMNAMEn columns is determined by the Sort column value of the ColumnSelections window.

The TM1 fact table has the following columns with the following descriptions and data types:

DIMNAME1 - DIMNAMEnDIMNAME1 - DIMNAMEn is the name of the columns 1 - n that are selected to be exported. If Thecolumn values are member names that correspond to the CHILD field of the respective dimensiontable.varchar(255) or varchar2(255)

DATAContains the actual data value of the dimension member intersection. The precision of this field (x) isbased on the Data Precision option of the Selection that is used to create the table. Only numeric factdata is supported.numeric (17,x) or number(17,x)

AUDITIDWhen a data extraction is run, the Integration Server adds or updates the AUDITID field in the facttable. The AUDITID references a record in the fact audit table. This table has the same name as thefact table, plus a suffix of _AUDIT.int or number


CIS Star Schema metadata tableTBD

TBD

TBDTBD

Notices

This information was developed for products and services offered worldwide.

This material may be available from IBM in other languages. However, you may be required to own a copyof the product or product version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries.Consult your local IBM representative for information on the products and services currently available inyour area. Any reference to an IBM product, program, or service is not intended to state or imply that onlythat IBM product, program, or service may be used. Any functionally equivalent product, program, orservice that does not infringe any IBM intellectual property right may be used instead. However, it is theuser's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.This document may describe 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 matter described in this document.The furnishing of this document does not grant you any license to these patents. You can send licenseinquiries, 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 IBM Intellectual PropertyDepartment 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 other country where suchprovisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATIONPROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodicallymade to the information herein; these changes will be incorporated in new editions of the publication.IBM may make improvements and/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 for convenience only and do not inany manner serve as an endorsement of those Web sites. The materials at those Web sites are not part ofthe materials for this IBM product 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 it believes appropriate withoutincurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information 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 material available for it are provided byIBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or anyequivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, theresults obtained in other operating environments may vary significantly. Some measurements may havebeen made on development-level systems and there is no guarantee that these measurements will be thesame on generally available systems. Furthermore, some measurements may have been estimatedthrough extrapolation. Actual results may vary. Users of this document should verify the applicable datafor their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to the suppliers ofthose products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal withoutnotice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to the names and addresses used by anactual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

This Software Offering does not use cookies or other technologies to collect personally identifiableinformation.

©

Product Information

This document applies to IBM Cognos Integration Server Version 10.2.3 and may also apply tosubsequent releases.

Copyright

Licensed Materials - Property of IBM© Copyright IBM Corp. 2005, 2018.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP ScheduleContract with IBM Corp.

Notices 147

IBM, the IBM logo and ibm.com are trademarks or registered trademarks of International BusinessMachines Corp., registered in many jurisdictions worldwide. Other product and service names might betrademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information " at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:

• Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in theUnited States, other countries, or both.

• UNIX is a registered trademark of The Open Group in the United States and other countries.• Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or

its affiliates.


http://www.ibm.com/legal/copytrade.shtml

Index

AAudit table 134audit table persistence parameters 16

Bbatch mode 94

Cchannel registration

satellite servers 16CIS Star Schema metadata tables 146cloning connections 24cloning selections 26command file syntax 97command line utility 90, 94configuration

HFM clusters with multiple nodes 19software license metric 20

configuration filessetting 16

configuring Essbase selections 46Connection Manager 22connection parameters

DB2 78Essbase 72HANA 63, 76HFM 74Oracle 77Planning 72SAP BW 63, 76SQL Server login 76SQL Server trusted connection 76star schema 64text file 78TM1 62, 75

connectionscloning 24creating 23, 67deleting 24, 72editing 24, 71exporting 24ID 23, 67importing 25satellite server 23testing 23, 71viewing 25

creating connections 23, 67cube extraction options 33custom data value filters 4custom name mapping parameters 18custom scope control 4

Ddata extraction audit 6database column names

mapping 9database table names 9database tool

setting 11deleting connections 24, 72deleting selections 26dimension tables

Essbase 110HFM accounts 112HFM custom1- 4 125HFM ICP 124HFM period 122HFM scenario 118HFM view and value 127HFM year 121TM1 144

Dimension tablesHFM entity 116

Eediting connections 24, 71editing selections 26Essbase

column selections 49extraction types 50member list selection 48member selection 47member selections 50

Essbase and HFM narrow fact table 128Essbase and HFM wide fact table 129Essbase data extractor

installing 12setting properties 13starting 14

Essbase dimension table 110Essbase filters tables 134Essbase outline 47Essbase selections

configuring 46Essbase users tables 136exporting connections 24exporting selections 27extraction options

cube 33data 34Essbase and Planning 38HFM 41metadata 33Planning+ 46SAP 36SAP BW 34star schema 28, 44

149

extraction options (continued)TM1 37

Ffact table field length parameters 17fact table persistence parameters 18fact tables

Essbase and HFM narrow 128Essbase and HFM wide 129Essbase filters 134Essbase users 136HFM cell history 142HFM cell line item details 141HFM cell text 141HFM journal items 138HFM journals 139HFM process management 137Planning account annotations 130Planning cell text 130Planning form annotations 131Planning supporting details 133Planning unit 132TM1 145

fact TablesAudit 134

Ggeneration format 33, 106

HHFM accounts dimension table 112HFM cell history fact table 142HFM cell line item details fact table 141HFM cell text fact table 141HFM clusters with multiple nodes 19HFM custom1- 4 dimension table 125HFM entity dimension table 116HFM ICP dimension table 124HFM journal items fact table 138HFM journals fact table 139HFM list members

selecting 53HFM period dimension table 122HFM process management fact table 137HFM scenario dimension table 118HFM view and value dimension tables 127HFM year dimension table 121

IIBM Cognos Integration Server

overview 3IBM DB2 database

initializing 12importing connections 25importing selections 27Integration Server

basics 7tools 8

Integration Server Manager

Integration Server Manager (continued)starting 8

intelligent extractionsetting up 5

interactive mode 90

Llarge data values parameters 20level format 33, 108license usage

viewing 16log entries

viewing 89log records

exporting 89log results

filtering 89log viewer

using 88

Mmaster data management format 109member names

mapping 10member selection validation parameters 22metadata extraction options 33metadata tables

CIS Star Schema 146SAP BW 144

Microsoft SQL Server databaseinitializing 11

Nname quotes parameters 18new features

in version 10.2.1 2in version 10.2.2 2in version 10.2.2.1 2in version 10.2.3 2

Oopening selections 26Oracle database

initializing 11Oracle Essbase extraction

options 4Oracle Essbase metadata extraction 5Oracle Essbase security extraction 5Oracle Hyperion Financial Management extraction 6Oracle Hyperion Planning data extraction 6outlines

searching for members 59

Pparameters

audit table persistence 16custom name mapping 18fact table field length 17

150

parameters (continued)fact table persistence 18large data values 20member selection validation 22name quotes 18password persistence 20table suffix 21Unicode 21

parent-child format 106password persistence parameters 20Planning account annotations fact table 130Planning cell text fact table 130Planning form annotations fact table 131Planning supporting details fact table 133Planning unit fact table 132

SSAP BW data extraction 3SAP BW metadata tables 144satellite servers channel registration 16searching for outline members 59selection information

specifying 27Selection Manager

options 9using 25

selection optionsSAP BW 28

selectionscloning 26creating 26deleting 26editing 26exporting 27extraction options 27HFM 53importing 27opening 26Planning 52running 62SAP_BW InfoCubes 55SAP_BW InfoQueries 57Star Schema 58TM1 54

server-side substitution variablesselecting 48

software license metric configuration 20specifying selection information 27spin dimensions 49SQLite database

initializing 12star schema

fundamentals 105Star Schema Connection Manager 64star schema extraction options

Integration Server 32star schema options

Essbase and Planning 29HFM 30

star schema selection optionsTM1 29

Ttable suffix parameters 21testing connections 23, 71TM1 dimension tables 144TM1 fact tables 145

UUnicode parameters 21

151

Cognos Integration Server Administration Guidepublic.dhe.ibm.com/software/data/cognos/... · data,...

Documents

Transcript of Cognos Integration Server Administration Guidepublic.dhe.ibm.com/software/data/cognos/... · data,...