sis 2.8.3 admin guide

© 2010 Star Analytics, Inc.

Administrator's GuideVersion 2.8.3

Star Integration Server

Star Integration ServerAdministrator's Guide

by Star Analytics, Inc.

All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, ormechanical, including photocopying, recording, taping, or information storage and retrieval systems - without thewritten permission of the publisher.

Products that are referred to in this document may be either trademarks and/or registered trademarks of therespective owners. The publisher and the author make no claim to these trademarks.

While every precaution has been taken in the preparation of this document, the publisher and the author assume noresponsibility for errors or omissions, or for damages resulting from the use of information contained in this documentor from the use of programs and source code that may accompany it. In no event shall the publisher and the author beliable for any loss of profit or any other commercial damage caused or alleged to have been caused directly orindirectly by this document.

Printed: September 2010

Administrator's Guide

© 2010 Star Analytics, Inc. Star Analytics, Inc

Administrator's GuideI


Table of Contents

Foreword 1

Part I Preface 2

................................................................................................................................... 21 Audience

................................................................................................................................... 22 Document Structure

................................................................................................................................... 23 Conventions

Part II Star Integration Server Overview 3

................................................................................................................................... 31 Introduction

................................................................................................................................... 42 Star Integration Server Deployment Topology

................................................................................................................................... 53 Star Integration Server Deployment Architecture

................................................................................................................................... 74 Star Integration Server Components

................................................................................................................................... 75 Star Integration Server Features

.......................................................................................................................................................... 7Hyperion Essbase Extraction

......................................................................................................................................................... 8Optimized Essbase Data Extraction

......................................................................................................................................... 8Leverage Calculation Engine Speed

......................................................................................................................................... 8Intelligent Extraction

......................................................................................................................................... 10Custom Data Value Filtering

......................................................................................................................................... 11Custom Scope Control

......................................................................................................................................................... 11Hyperion Essbase Metadata Extraction

......................................................................................................................................................... 11Hyperion Essbase Security Extraction

.......................................................................................................................................................... 11Hyperion Planning Data Extraction

.......................................................................................................................................................... 12Hyperion Financial Management Extraction

......................................................................................................................................................... 12Optimized HFM Data Extraction

......................................................................................................................................................... 13HFM Metadata Extraction

.......................................................................................................................................................... 13Load Balancing with Satellite Servers

.......................................................................................................................................................... 14Data Extraction Auditing

Part III Star Integration Server Start Menu Items 15

Part IV Using the Star Integration Server 16

................................................................................................................................... 171 Launching the Star Integration Server Manager

................................................................................................................................... 192 Setting the SIS Configuration Options

.......................................................................................................................................................... 19Selection Manager Options

.......................................................................................................................................................... 22Target Database Table and Column Name Mapping

.......................................................................................................................................................... 22Setting Config File Options

......................................................................................................................................................... 24Channel Registration for SIS Satellite Servers

......................................................................................................................................... 24Client-side Channel Registration

......................................................................................................................................... 24Server-side Channel Registration and Remote Object Leases

......................................................................................................................................................... 25SIS Essbase API Version

......................................................................................................................................................... 25Splash Screen Display Time

......................................................................................................................................................... 25HFM Star Schema Table Name Mapping

......................................................................................................................................................... 26Use Auto Connection Parameter Update

......................................................................................................................................................... 26Data Value Field Length in Star Schema Fact Table

......................................................................................................................................................... 26Extended Connection String Parameters for the SIS DB

IIContents

II


......................................................................................................................................................... 26SIS Database Configuration File Location

......................................................................................................................................................... 26Table Suffixes

......................................................................................................................................................... 27HFM Extraction parameters

......................................................................................................................................................... 29License Key

......................................................................................................................................................... 29Password Persistense

......................................................................................................................................................... 29FACT Table Persistence

......................................................................................................................................................... 29Audit Table Persistence

......................................................................................................................................................... 30FACT Table and Column Names Quotes

......................................................................................................................................................... 30Validate Member Selections Before Running SISCMD

......................................................................................................................................................... 30HFM Data Link Path

................................................................................................................................... 313 Changing the License Key

................................................................................................................................... 314 Changing to a Different SIS Database

................................................................................................................................... 335 Updating the SIS Database

................................................................................................................................... 366 Updating the Essbase Extractor

.......................................................................................................................................................... 39Essbase server installed on the same server as SIS

.......................................................................................................................................................... 41Essbase server installed on a different server

.......................................................................................................................................................... 42Essbase server installed on a UNIX server

.......................................................................................................................................................... 44Setting Hyperion Essbase Extractor Properties

................................................................................................................................... 467 Using the Connection Manager

.......................................................................................................................................................... 47Creating a Connection

.......................................................................................................................................................... 49Connection ID

.......................................................................................................................................................... 49Enabling a Connection to use Satellite Server

.......................................................................................................................................................... 50Testing a Connection

.......................................................................................................................................................... 52Editing a Connection

.......................................................................................................................................................... 54Deleting a Connection

.......................................................................................................................................................... 55Cloning a Conection

.......................................................................................................................................................... 55Exporting a Connection

.......................................................................................................................................................... 56Importing a Connection

.......................................................................................................................................................... 57Viewing Connection Uses

.......................................................................................................................................................... 59Connection Parameters

......................................................................................................................................................... 60Essbase Connection Parameters

......................................................................................................................................................... 61Planning Connection Parameters

......................................................................................................................................................... 65HFM Connection Parameters

......................................................................................................................................................... 71SQL Server - Trusted Connection Parameters

......................................................................................................................................................... 72SQL Server - Login Connection Parameters

......................................................................................................................................................... 74Oracle Connection Parameters

......................................................................................................................................................... 76DB2 Connection Parameters

......................................................................................................................................................... 77Sybase Connection Parameters

......................................................................................................................................................... 78MySQL Connection Parameters

......................................................................................................................................................... 79Text File Connection Parameters

......................................................................................................................................................... 81Satellite Server Connection Parameters

................................................................................................................................... 828 Using the Selection Manager

.......................................................................................................................................................... 82Creating a new Selection

.......................................................................................................................................................... 83Opening (Editing) a Selection

.......................................................................................................................................................... 84Deleting a Selection

.......................................................................................................................................................... 85Cloning a Selection

.......................................................................................................................................................... 86Importing a Selection

.......................................................................................................................................................... 87Exporting a Selection

.......................................................................................................................................................... 88Setting Extraction Options

......................................................................................................................................................... 88Selection Information

......................................................................................................................................................... 89Star Schema Options

......................................................................................................................................................... 94Metadata Extraction Options

Administrator's GuideIII


......................................................................................................................................................... 96Data Extraction Options

......................................................................................................................................................... 104Planning+

.......................................................................................................................................................... 105Configuring an Essbase Selection

......................................................................................................................................................... 105Selecting Members From an Essbase Outline

......................................................................................................................................................... 107Selecting Members From a List of Essbase Members

......................................................................................................................................................... 107Selecting Server-Side Substitution Variables

......................................................................................................................................................... 109Essbase Column Selections

......................................................................................................................................... 109Spin Dimension

......................................................................................................................................................... 110Essbase Member Selections

......................................................................................................................................................... 112Choosing the right Essbase Extraction Type

.......................................................................................................................................................... 114Configuring a Planning Selection

.......................................................................................................................................................... 114Configuring an HFM Selection

......................................................................................................................................................... 115Selecting Members From an HFM Outline

......................................................................................................................................................... 117Selecting Members From an HFM Member List

......................................................................................................................................................... 119HFM Column Selections

......................................................................................................................................................... 120HFM Member Selections

.......................................................................................................................................................... 121Searching for Outline Members

.......................................................................................................................................................... 121Running a Selection

................................................................................................................................... 1239 Using the Log Viewer

.......................................................................................................................................................... 123Information in the Log Viewer

.......................................................................................................................................................... 124Filtering the View

.......................................................................................................................................................... 125Viewing Individual Log Entries

.......................................................................................................................................................... 126Exporting the Log View

................................................................................................................................... 12710 Using the SIS Command Line Interface

.......................................................................................................................................................... 127SISCMD Interactive Mode

.......................................................................................................................................................... 141SISCMD Batch Mode

.......................................................................................................................................................... 143SISCMD Command File Syntax

Part V Appendix A - SIS Star Schema Definition 149

................................................................................................................................... 1491 Overview

................................................................................................................................... 1502 Star Schema Fundamentals

................................................................................................................................... 1523 Parent/Child Format

................................................................................................................................... 1524 Generation Format

................................................................................................................................... 1545 Master Data Management Format

................................................................................................................................... 1556 Essbase Dimension Table

................................................................................................................................... 1577 HFM Accounts Dimension Table

................................................................................................................................... 1618 HFM Entity Dimension Table

................................................................................................................................... 1639 HFM Scenario Dimension Table

................................................................................................................................... 16610 HFM Year Dimension Table

................................................................................................................................... 16711 HFM Period Dimension Table

................................................................................................................................... 16812 HFM ICP Dimension Table

................................................................................................................................... 16913 HFM Custom1- 4 Dimension Tables

................................................................................................................................... 17114 HFM View and Value Dimension Tables

................................................................................................................................... 17215 Narrow Format FACT Table

................................................................................................................................... 17216 Wide Format FACT Table

................................................................................................................................... 17317 Planning Account Annotations FACT Table

IVContents

IV


................................................................................................................................... 17418 Planning Cell Text FACT Table

................................................................................................................................... 17419 Planning Form Annotations FACT Table

................................................................................................................................... 17520 Planning Planning Unit FACT Table

................................................................................................................................... 17521 Planning Supporting Details FACT Table

................................................................................................................................... 17622 Audit Table

................................................................................................................................... 17723 Essbase Filters Tables

................................................................................................................................... 17924 Essbase Users Tables

................................................................................................................................... 18025 HFM Process Management FACT Table

................................................................................................................................... 18126 HFM Journal Items FACT Table

................................................................................................................................... 18227 HFM Journals FACT Table

................................................................................................................................... 18328 HFM Cell Line Item Details FACT Table

................................................................................................................................... 18429 HFM Cell Text FACT Table

................................................................................................................................... 18530 HFM Cell History FACT Table

Part VI Appendix B - Hyperion Planning & DrillThrough Analytics 187

................................................................................................................................... 1871 Overview

................................................................................................................................... 1882 Star Integration Server - Bridge to Relational

................................................................................................................................... 1893 Essbase Integration Server - Bridge to Essbase

................................................................................................................................... 1904 EIS Drill-Through Reporting with Template SQL

................................................................................................................................... 1915 Setting up Drill-Through Reports

................................................................................................................................... 1946 Drill-Through Analytics Workflow

Part VII Appendix C - Hyperion Essbase IntegrationServices 197

................................................................................................................................... 1971 Overview

................................................................................................................................... 1972 Basic Components

.......................................................................................................................................................... 197OLAP Catalog

.......................................................................................................................................................... 197OLAP Model

.......................................................................................................................................................... 198Meta Outline

................................................................................................................................... 1993 High Level Workflow

................................................................................................................................... 1994 EIS Example

.......................................................................................................................................................... 199Connect to EIS

.......................................................................................................................................................... 200Build OLAP Model

.......................................................................................................................................................... 201Set Properties of OLAP Model

.......................................................................................................................................................... 203Create Meta Outline

.......................................................................................................................................................... 203Set Dimension and Member Properties

.......................................................................................................................................................... 204Create Attribute Dimensions

.......................................................................................................................................................... 205Set Database Measures

.......................................................................................................................................................... 207Building the Essbase Cube

Index 209

Foreword

The STAR Integration Serve (SIS) is an automatedbridge that solves the difficulty of sharing HyperionPlanning, Hyperion Financial Management and HyperionEssbase data with other applications and databases. SISextends the use and availability of Hyperion BPM,necessary for real-time planning, un-interruptedapplications availability, and strategic reporting platforms.

Foreword1


Preface 2


1 Preface

· Audience

· Document Structure

· Conventions

1.1 Audience

This guide is for Hyperion system administrators responsible for setting up extractions,working with supported connections and using the Star Integration Manager.

1.2 Document Structure

This guide contains the following sections:

· Star Integration Server Overview

· Using the Star Integration Server

· Appendix A: SIS Star Schema Definitions

· Appendix B: Hyperion Planning and Drill Through Analytics

· Appendix C: Hyperion Essbase Integration Services

1.3 Conventions

The following conventions are used throughout this guide:

Example Description

\ESSBASE\BIN Names of files, directories or environmental variables appear inthis font

New Connection Name of buttons or keys to be pressed or clicked

Selection ManagerOptions

Online help topics appear in italics; also used for importantterms requiring special emphasis

File è Open Arrow (è) indicates a menu followed by an individual menucommand

2

2

2

Administrator's Guide3


2 Star Integration Server Overview

· Introduction

· Star Integration Server Deployment Topology

· Star Integration Server Deployment Architecture

· Star Integration Server Components

· Star Integration Server Features

2.1 Introduction

Star Analytics' Star Integration Server (SIS) provides the ideal solution for Hyperioncustomers seeking a high-performance, automated method of extracting and sharingtheir proprietary Hyperion BPM data with relational data stores and other BusinessIntelligence (BI) applications. SIS takes your Hyperion BPM applications to a new level,by extracting the information in your Hyperion applications into a BI Warehouse or anyother BI application or reporting system, creating a tremendous variety of powerfulreporting and analysis options.

SIS allows you to share more than just data, however, it opens up and makes availablethe proprietary structures, calculations, business rules, supporting detail, even securityinformation in all the major Hyperion applications. Using a graphical user interface,Hyperion system administrators can easily create and manage complex data movementsbetween applications either manually, or as lights-out, seamless operations with fullauditing and notification. SIS also facilitates single-source reporting, continuous planningand transaction drill through.

SIS supports the following scenarios:

· Hyperion Essbase Data to RDBMS star schema FACT table

· Hyperion Essbase Data to ASCII flat file

· Hyperion Essbase Metadata to Star schema dimensional tables in Parent/Childformat, Balanced Generation format and Master Data Management format withnative Essbase attributes

· Hyperion Essbase Metadata to ASCII flat file in Parent/Child format, BalancedGeneration format and Master Data Management format with native Essbaseattributes

· Hyperion Essbase Security to RDBMS table or text file

· Hyperion Planning Data to RDBMS star schema FACT table

· Hyperion Planning Data to ASCII flat file

· Hyperion Financial Management Data to RDBMS star schema FACT table

· Hyperion Financial Management Data to ASCII flat file

· Hyperion Financial Management Metadata to Star schema dimensional tablesin Parent/Child format, Balanced Generation format and Master DataManagement format with native Essbase attributes

3

4

5

7

7

Star Integration Server Overview 4


· Hyperion Financial Management Metadata to ASCII flat file in Parent/Childformat, Balanced Generation format and Master Data Management format withnative Essbase attributes

Key features of the SIS solution include:

· SIS extends your BPM capabilities by extracting and transforming any level ofdata, metadata and security information from Hyperion Essbase, HyperionPlanning and Hyperion Financial Management for use in other enterpriseapplications or reporting systems

· ENABLE REAL-TIME PLANNING, CALCULATIONS AND UPDATES using thepowerful automated extraction capabilities of SIS to move your Hyperion datato where it's needed, when it's needed

· 100% APPLICATION AVAILABILITY - SIS permits multiple, parallel extractionswithout ever taking your Hyperion applications off-line

· HIGH PERFORMANCE - SIS achieves a new level of speed, transparency andconsistency through the use of unique extraction technologies

· INTUITIVE USER INTERFACE AND PREVIEW CAPABILITIES - review yourHyperion structures and extraction selections and easily define, modify andsave the required data transformations, mappings and calculations

· AUDITABLE CONSISTENCY - SIS automation capabilities such as e-mail alertsand audit logs help to ensure data security and Sarbanes-Oxley compliancevia automated hands-off/lights-out operation

2.2 Star Integration Server Deployment Topology

The following diagram illustrates the flexibility that the SIS provides within a HyperionBPM deployment. SIS bridges the gap between Hyperion multidimensional technologiessuch as Hyperion Essbase and Hyperion Financial Management and relational technologysuch as Microsoft SQL Server and Oracle relational database management systems.

SIS makes the Hyperion BPM data available in a relational star schema database orASCII text file that can be used to feed native Essbase cubes via native Essbase rulesfiles and enhanced reporting Essbase cubes created via Essbase Integration Services(EIS). Additionally, the data extracted by SIS to the relational database can be useddirectly by relational reporting tools such as Hyperion Intelligence or simplistic ExcelPivot Tables.



2.3 Star Integration Server Deployment Architecture

The following diagrams show two typical ways of deploying the SIS. In the standarddeployment architecture the SIS Manager and SIS Server are installed on the sameserver as Essbase and/or HFM.

To allow connectivity to a remote HFM server the Satellite Server deploymentarchitecture is the preferred solution. In this situation the SIS Manager is installed onone server and the Satellite Server is installed on the remote server. The Satellite Serverdeployment architecture may also provide a performance boost since the since theEssbase or HFM extraction occurs on the remote server and not on the SIS Managerserver. See also Load Balancing with Satellite Servers for additional uses of theSatellite Server.

The SIS Manager and Satellite Server run under Windows 2000, Windows XP, orWindows 2003 Server with Microsoft .NET 2.0 Framework installed.

Standard Deployment Architecture

13



Satellite Server Deployment Architecture



2.4 Star Integration Server Components

The following diagram shows the SIS Component Architecture that allows for seamlessintegration with Hyperion Essbase, Hyperion Planning and Hyperion FinancialManagement (HFM) for the purpose of extraction of data and metadata into a standardsbased format.

The SIS Component Architecture is built to be extensible and provides for additional"snap-in" applications.

2.5 Star Integration Server Features

· Hyperion Essbase Extraction

· Hyperion Planning Extraction

· Hyperion Financial Management Extraction

· Load Balancing with Satellite Servers

· Data Extraction Auditing

2.5.1 Hyperion Essbase Extraction

· Optimized Essbase Data Extraction

· Hyperion Essbase Metadata Extraction

· Hyperion Essbase Security Extraction

7

11

12

13

14

8

11

11



Optimized Essbase Data Extraction2.5.1.1

Various options can be configured to optimize the Essbase data extraction performance.Use the following links for details on the options:

· Leverage Calculation Engine Speed

· Intelligent Extraction

· Custom Data Filtering

· Custom Scope Control

Leverage Calculation Engine Speed2.5.1.1.1

The SIS leverages the Hyperion Essbase calculation engine to extract data from HyperionEssbase. This has a key performance distinction from the Hyperion Essbase Reportingengine.

Hyperion Essbase Report Script Engine

The Hyperion Essbase Report Script Engine is intended to output data from Essbasebased on the parameters set in the Report Script. The intersections requested in a reportscript may or may not have data. From a reporting standpoint, it is important that allintersections requested, whether data exists or not, be displayed in the report output.

Hyperion Essbase Calculation Engine

The Hyperion Essbase calculation engine is intended to perform calculations on existingdata blocks. As such, the calculation engine only operates on blocks that actually exist.When SIS extracts data using the Hyperion Essbase calculation engine, only blocks thatexist in the extract are examined. This can have significant performance gains over thereport script engine which looks at all possible intersection points regardless of whether ablock exists. The performance gains become more pronounced when a Hyperion EssbaseDatabase is more sparse. In other words, there are more intersection points that do nothave existing data blocks which the Report Script Engine traverses but the CalculationEngine ignores.

Intelligent Extraction2.5.1.1.2

The SIS leverages the Hyperion Essbase calculation engine to take advantage of thestatus of each data block within the database. Each data block within Hyperion Essbasecan have a "clean" or "dirty" status meaning that a status of "dirty" indicates that a valuein the block has been changed since the last calculation script with intelligent calculationturned on has been executed against it.

SIS can leverage the clean and dirty status of a given data block with its IntelligentExtraction Option of a given Selection. When Intelligent Extraction is selected in aSelection, data blocks with a status of "dirty" are extracted and data blocks with a statusof "clean" are ignored. The result is only exporting data that has changed rather than theentire data set specified in the Selection. The Set Data As Clean option also allows "dirty"data blocks to be reset to "clean" after extraction.

8

8

10

11



This Intelligent Extraction feature can provide for significant data extraction times whenonly a small amount of data has been changed that needs to be updated in the targetconnection of the Selection. Since Selections with the Intelligent Extraction optionselected only pulls a subset of data then the Selection normally would, it is typical thatthe Load Type option be set to Merge and any data suppression turned off. This iscritical since data changed from a number to 0 or #Missing are still extracted to thetarget connection to update the existing value. If suppress zero or #Missing were to beturned on, no records would have been exported and the record in the target connectionwould contain the original value leaving the target data out of sync with the EssbaseDatabase.

For more information on intelligent calculation of Hyperion Essbase calculation scripts,see the Essbase Administrators Guide.

Setting Up an Intelligent Extraction

1) Run a full SIS extraction with the following options checked:

a) Star Schema Options Tab

i) Select Create Star Schema (if not previously created)

ii) Any FACT Table format will be fine

iii) Any FACT Table Member value will be fine

iv) Any Dimension Table layout will be fine

b) Metadata Extraction Options Tab

i) Select Extract Metadata

c) Data Extraction Options Tab

i) Select Extract Data

ii) Select Load Type "Refresh"

iii) Select Suppress Zeros and Missing

iv) Select "Type I" extraction type

d) Save the Selection and Run the extraction

2) Create the following calc script

a) SET CLEARUPDATESTATUS ONLY;

CALC ALL;

b) Save the calc script as “Clean”

c) Run "Clean"

3) Clone the Selection created in step #1 and make the following changes tothe new extraction:

a) Rename the Selection to include the word “Intel” or “Intelligent” (optional)

97

85



b) Star Schema Options Tab

i) Uncheck “Create Star Schema”

c) Metadata Extraction Options Tab

i) Uncheck “Extract Metadata”

d) Data Extraction Options Tab

i) Change Load Type to “Merge”

ii) Change Suppression to “No Suppression”

iii) Select “Intelligent Extract” and “Set data as clean”

e) Save and schedule this new extraction to run every 2 to 10 minutes(recommended)

i) Using Windows Scheduler and a SISCMD batch file. For example:

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

DATE /t >> .\BAT_STAT.TXT

TIME /t >> .\BAT_STAT.TXT

"C:\Program Files\Star Analytics\SIS\SISCMD.exe" 2>>.\BAT_STAT.TXT

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

DATE /t >> .\BAT_STAT.TXT

TIME /t >> .\BAT_STAT.TXT

It is recommended that on a weekly basis, the Full Extract Selection be run and eitherdrop and recreate the star schema or at least truncate the tables and reload with theSIS “Refresh” option. Over the course of a week, records with a <NULL> value thatrepresent a prior values or a non-value can cause the FACT table to be larger thannecessary.

Note: Intelligent Extraction is currently only available for "Type I" extraction type.

Custom Data Value Filtering2.5.1.1.3

Custom Data Value Filtering provides custom data value filters on Essbase Selections.Custom Data Value Filtering limits the Selection output based on standard Essbase IFcondition syntax. Custom Data Value Filtering is similar to our custom formulafunctionality in a Selection, but at the Selection level rather than at the memberselection level.



See Data Extraction Options for more information on Custom Data Value Filtering.

Note: Custom Data Value Filtering is currently only available for Extraction Type I.

Custom Scope Control2.5.1.1.4

Custom Scope Control provides further data filtering options on Essbase Selections. Custom Scope Control provides filtering at the Selection level, and can contain a widevariety of Essbase calculation functions. This control is also used in conjunction with theImplicit Share Extraction feature such as using LEVELS, GENERATIONS or UDAs to definedata to be extracted.

For example:

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

See Data Extraction Options for more information on Custom Scope Control.

Note: Custom Data Value Filtering is currently only available for Extraction Type I.

Hyperion Essbase Metadata Extraction2.5.1.2

SIS has the capability to extract Hyperion Essbase outline metadata. There are threeprimary formats: Parent/Child, Balanced Hierarchy and Hyperion Master DataManagement format. For a description of these formats see Appendix A - SIS StarSchema Definition .

The Parent/Child format is best suited for ragged hierarchies. This format also providesall outline metadata attributes such as alternate alias tables, user defined attributes,member formulas and calculation logic such as solve order.

The Balanced Hierarchy format is used to create conforming hierarchies from a raggedhierarchy. This is used primarily to recreate the same drill path that a user has inside ofthe multidimensional application in a relational reporting environment.

The Hyperion Master Data Management (MDM) format provides the ability to extractmetadata in the MDM "Automator" format that can be easily imported into MDM.

Hyperion Essbase Security Extraction2.5.1.3

The SIS server can extract Essbase security related information such as users, groups,user to group associations, filters and filters to user/group association.

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

See the Metadata Extraction Options of a Selection for more information on extractingHyperion Essbase Security.

2.5.2 Hyperion Planning Data Extraction

SIS has the capability to extract some of the Hyperion Planning application data stored inthe Hyperion Planning relational database. The current capability provides for the

101

96

149

94



following extractions:

· Supporting Detail

· Cell Notes

· Account Annotations

· Planning Unit Annotations

· Form Annotations

2.5.3 Hyperion Financial Management Extraction

· Optimized HFM Data Extraction

· HFM Metadata Extraction

Optimized HFM Data Extraction2.5.3.1

The SIS server can extract any combination of data from any HFM application and placeit into a relational FACT table, or into an ASCII text file.

This version of SIS has an improved extraction algorithm to balance the work effectivelybetween SIS and HFM and to take advantage of the hardware environment duringextractions.

Improved Algorithm

The SIS HFM data extraction engine has a highly tuned algorithm for filtering out dataintersection points requested in a Selection that do not have any data associated withthem. Typically, a very low percentage of a Selection's total intersection points havedata. By eliminating the intersections without data early on and focusing on those thatdo have data, performance improves dramatically.

Work Balanced Between SIS and HFM

The SIS HFM data extractor leverages high performance HFM API calls with an improvedSIS algorithm to achieve significant performance gains. SIS generates batches of validdata intersection points and submit them to the HFM API to retrieve the data associatedwith such intersections. This results in less frequent calls made to the HFM API whichinherently have a great deal of overhead associated with them.

Takes Advantage of Hardware Environment

As stated in the previous section, SIS batches up data intersection points prior to makingHFM API calls. The fewer API calls that need to be made, the better the data extractionperformance typically is. The more memory on the SIS Server, the larger the SIS batchescan be to reduce HFM API calls and maximize performance. HFM Selections have anoption to control the amount of memory allocated to the SIS data intersection pointbatches. The higher this memory setting, the less HFM API calls made and greater theperformance.

This option is called Memory Cache and can be found on the Data Extraction Optiontab of a Selection.

12

13

101 96



The SIS HFM data extraction engine can take advantage of multi-CPU servers for furtherimprovements in extraction speed. When SIS has generated a batch of intersectionpoints it immediately submits them to the HFM API for processing. Without waiting forHFM to complete the processing it continues to generate a new batch of intersectionpoints, submits them to HFM and so on. See HFM Extraction parameters on how to setthe maximum number of outstanding requests to the HFM API. In general, the moreCPUs the SIS server has, the more HFM requests it can process in parallel and the fasterthe extraction is. Beyond a certain number of requests the benefit of adding morerequests to HFM tapers off and performance may actually decrease.

HFM Metadata Extraction2.5.3.2

Identical to Essbase metadata extraction...

2.5.4 Load Balancing with Satellite Servers

The SIS Satellite Server is a Windows service running on a machine that can executeSelection requests from another machine. All of the Selection processing occurs on theSatellite Server. The Satellite Server contains all of the key SIS Server files andcommunicates interactively with the SIS client as to the progress of the runningSelection.

Satellite Servers have the following benefits:

· Provides for distributed processing where all of the processing of a Selection can beperformed on a Satellite Server where either HFM or Essbase is installed.

· Provide for the SIS client to be installed and operated on a machine without requiringHFM or Essbase to be installed

· Provides for location transparency where a SIS client can control and executeSelections running on any remote machine

· Reduces network traffic for large data extractions where data can be transferred locallybut executed remotely

The following diagram illustrates the use of a Satellite Server to run a HFM or EssbaseSelection remotely over a WAN.

Note that neither HFM nor Essbase is installed on the client machine. The client machinestill receives feedback as to the progress of the selection processing, however all of theprocessing is done remotely. All management of HFM or Essbase Server can be done on aremote machine.

27



In summary, there are two significant benefits to using load balancing with SatelliteServers:

· Improved performance

· Ease of machine configurations

2.5.5 Data Extraction Auditing

Data Extraction Auditing creates a correlation between each data extraction and theSelection that was used in the data extraction. When Data Extraction Auditing isenabled, each time a data extraction is run, a FACT table audit record is added to theaudit table. The audit table is a data table created by SIS in the relational targetdatabase with the same name as the FACT table but appended with the "_AUDIT" suffix.The audit table has a unique ID for each record. The ID value is also stored in theAUDITID field of each FACT table record so that each data record in the FACT table has areference to the audit table record. For instance, to determine the age of FACT table datarecords, a SQL query can be built linking the relationship between the FACT tableAUDITID and the ID field in the audit record.

See Audit Table for information on the contents of the audit table.

Data extraction auditing could potentially slow down a Selection run. SIS allows for theoption of turning both auditing and selection state preservation on or off. See Selection

19

176



Manager Options for more details.

3 Star Integration Server Start Menu Items

The following menu items are available in the Windows Start Menu in the Star Analyticsprograms folder as part of the Star Integration Server:

Change Star Integration Server Database

Allows you to switch between different SIS databases. See Changing the SIS Database

SISCMD Utility

Starts the SIS Command Line Interface console. See Using the SIS Command LineInterface for details.

Star Integration Server Admin Guide

Opens the Star Integration Server Admin Guide.

Star Integration Server Database Update Tool

Allows you to initialize a new SIS database or to update an existing one. See Updatingthe SIS Database for details.

Star Integration Server Essbase Extractor Update Tool

Allows you to install or update the SIS Essbase Extractor tool on the Essbase server. See Updating the Essbase Extractor for details.

Star Integration Server Manager

Launches the Star Integration Server Manager

19

31

127

33

36

Using the Star Integration Server 16


4 Using the Star Integration Server

Using the Star Integration Server to extract data from Hyperion Essbase, HFM andPlanning applications consists of:

· Setting the SIS configuration options

· Using the Connection Manager to configure Connections to the Hyperionapplications and to the target SQL Server databases, Oracle databases or textfiles

· Using the Selection Manager to select the Hyperion application data to extract

· Running the Selections to extract the data

All of the activity of SIS is logged centrally in the SIS database. This log information canbe viewed using the SIS Log Viewer. The Log Viewer provides for filtering based on date,log type, Selection and process. Additionally, information in the Log Viewer can beexported to an ASCII text file if needed.

See Also:

· Launching the Star Integration Server Manager

· Configuring the Star Integration Server

· Using the Connection Manager

· Using the Selection Manager

· Using the Log Viewer

· Using the SIS Command Line Interface

17

19

46

82

123

127



4.1 Launching the Star Integration Server Manager

The Star Integration Server Manager can be launched from the Start Menu or bydouble-clicking on the SIS Manager icon on the desktop. The initial window displays,similar to the following sample:

If the Star Integration Server Manager is running on a 64-bit platform and you choseOracle as the Star Integration Server database, you will see this dialog the first time youlaunch the Star Integration Server Manager:

Click OK and the Star Integration Server Database Update Tool will open. Use the tool toconfigure the Star Integration Server database. See Updating the SIS Database fordetails.

33



If you are licensed for Essbase BSO data extractions you will see this dialog the first timeyou launch the Star Integration Server Manager:

Click OK to launch the Essbase Extractor Update Tool. See Updating the EssbaseExtractor for details.36



4.2 Setting the SIS Configuration Options

The SIS configuration options determine the overall behavior of the SIS. Once the SIS issuccessfully installed, it is ready to use. Configuration options can be changed by eitherof the following methods:

· Options configurable using the SIS Manager

· Config file options

Use the SIS Manager to set Selection Manager options, configure the SIS database, settarget database table and column mapping and viewing/changing the SIS license key.

To view or set config file options, use an ASCII text file editor to open and edit the file StarAnalytics.SIS.exe.config located in the SIS install directory.

NOTE: The config file should not be modified under normal circumstances.

See Also:

· Selection Manager Options

· SIS Database Configuration

· Target Database Table and Column Name Mapping

· Setting the License Key

· Setting Config File Options

· Setting Hyperion Essbase Extractor Options

4.2.1 Selection Manager Options

Select Tools è Options from the SIS Manager menu to display the SelectionManager Options.

19

31

22

31

22

44



The table below describes each of the Selection Manager Options:

Option Description

Outline CachingOptions

· Set the caching options to cache the Essbase or HFMoutlines; caching the Essbase or HFM outlinessignificantly reduces the time it takes to open a selection

· If this option is turned on, the first time an outline froma given connection opens, the outline metadata iscached on the client; cache is used instead of queryingEssbase or HFM each time a selection is opened

· Cached outlines display the date and time of the cachedmetadata at the top of the outline tree

· Care must be taken to ensure that changes made to theunderlying outline in Essbase or HFM are propagated tothe cached outlines. To update the outline cache withthe latest metadata, right-click on the top of the outline node and click Refresh Outline From Source.

Data ExtractionAuditing

· Creates an audit table with the name of the FACT tableand a suffix of _AUDIT



Options · With each data extraction run, the audit table is updatedwith a record indicating the date and time of the run; anAudit ID is added to the FACT table to correspond to arecord in the audit table

· To save a binary copy of the selection and settings tothe audit table, select Save Selection Instance withAudit Data

· See Data Extraction Auditing for additionalinformation

Bulk Copy · Enables Bulk Copy for HFM and Essbase Type II and IVdata extractions. Inserts into the target FACT table usesbulk copy instead of standard insert statements.

· Using this option significantly improvement performanceover the standard insert statements.

EssbaseExtractorMessaging Port

· Sets the port number to be used by the EssbaseExtractor for sending messages back to the SIS Server;the Essbase extractor communicates with the SIS usingTCP, which requires a specified port number

· A port number of 0 allows the SIS to dynamically assignan available port number (recommended)

· A port number other than 0 can be used if only a specificport can be used for communication between theEssbase Extractor and SIS

Essbase APIVersion

· Sets the version of the Essbase API that SIS is using.

Set it to 11.1.2.x for compatibility with Essbase11.1.2.x servers

Set it to 11.1.1.x for compatibility with Essbase11.1.1.x servers

Set it to 9.x for compatibility with Essbase 9.xservers

Set it to 7.x for compatibility with Essbase 7.xservers

Set it to 6.5 for compatibility with Essbase 6.5servers

Note: Not all versions are supported on 64-bitplatforms.

14



4.2.2 Target Database Table and Column Name Mapping

SIS automatically uses the names of the dimensions to name the metadata tables andthe columns in the FACT table. In the situations where this behaviour is not desirable,you can use the Table and Column Name Mapping feature to modify the automaticallygenerated names.

The feature works by substituting a character string found in the initial name withanother character string. If more than one initial value/replacement value pair isspecified for a connection type the result of the first string substitution is used as input tothe next substitution from top to bottom of the mapping table.

Space and TAB characters can be entered as part of the initial value or replacement valuestrings as 'SPACE' or '\s' and 'TAB' or '\t' respectively, without the single quotes. If theinitial value string is left empty a space character is assumed.

4.2.3 Setting Config File Options

Use an ASCII text file editor to open and edit the config files located in the SIS installdirectory.

NOTE: The config files should under normal circumstances not be modified.

SIS Config Files:



· StarAnalytics.SIS.exe.config (options for the SIS Manager (client/server))

· SISCMD.exe.config (options for SIS command line interface (SISCMD))

· StarAnalytics.SatelliteService.exe.config (options for the Star IntegrationSatellite Server Service)

If you modify a config file, you must restart the SIS Manager, SISCMD, or the SatelliteServer depending on the config file you modified.

See Also:

· Channel Registration for SIS Satellite Servers

· Essbase API Configuration

· Splash Screen Display Time

· HFM Star Schema Table Name Mapping

· Use Auto connection Parameter Update

· Data Value Field Length in Star Schema FACT Table

· Extended Connection String Parameters for the SIS DB

· SIS Database Configuration File Location

· Table Suffixes

· HFM Extraction parameters

· License Key

· Password Persistence

· FACT Table Persistence

· Audit Table Persistence

· FACT Table and Column Names Quotes

· Validate Member Selections Before Running SISCMD

· HFM Data Link Path

24

25

25

25

26

26

26

26

26

27

29

29

29

29

30

30

30



Channel Registration for SIS Satellite Servers4.2.3.1

Satellite server channel registration options need to be set on both the client side andthe servers side. See Load Balancing with Satellite Servers for more information onSatellite Servers and their channels.

· Client-side Channel Registration

· Server-side Channel Registration and Remote Object Leases

Client-side Channel Registration4.2.3.1.1

Client-side channel registration may be set for both TCP and for HTTP. Client-sidechannel registration settings typically do not need to be modified, as they are automaticby the Satellite Server communication.

TCP · Faster than HTTP

· Allows the transmission of binary data and does not allow the penetrationof firewalls

· Only the port number can be modified, if necessary, as follows:

<channel name="ClientSideTCP" ref="tcp" port="0">

· Normally the port number is set to "0" for a client, allowing data to bereturned back from the satellite server to SIS

HTTP · Slower than TCP

· Does not allow the transmission of binary data and allows the penetrationof firewalls

· Only the port number can be modified, if necessary, as follows:

<channel name="ClientSideHTTP" ref="http" port="0">

· As with TCP, the port number is normally set to "0"

Server-side Channel Registration and Remote Object Leases4.2.3.1.2

The following option settings are specific to StarAnalytics.SatelliteService.exe.config.See Load Balancing with Satellite Servers and the Satellite Server Installation Guidefor more information on Satellite Server channels and leases.

· Server-Side Channel Registration: Similar to client-side channel registration,however, port ranges are machine specific because different machines using the sameSIS database may be on different subnets. In this case, each machine would require aseparate set of ports. Only the port numbers should be modified in the channelsettings. The port numbers assigned to the Satellite Server must not be used by anyother application on the machine and must not be blocked by a firewall.

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

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

13

24

24

13



· Server-Side Remote Object Leases: May be set in minutes or seconds.

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

SIS Essbase API Version4.2.3.2

SIS Essbase API Version Option

<add key="EssbaseApiVersion" value="9.x" />

· Set "EssbaseApiVersion" to 11.1.2.x for compatibility with Essbase 11.1.2.xservers

· Set it to 11.1.1.x for compatibility with Essbase 11.1.1.x servers

· Set it to 9.x for compatibility with Essbase 9.x servers

· Set it to 7.x for compatibility with Essbase 7.x servers

· Set it to 6.5 for compatibility with Essbase 6.5 servers

Note: This option is best set from the Selection Manager Options dialog.

Splash Screen Display Time4.2.3.3

Splash Screen Display Time Option

<add key="Splash" value="1500" />

· Determines the length of time that the startup splash screen displays

· Value is in milliseconds and "1500" is equivalent to 1.5 seconds

HFM Star Schema Table Name Mapping4.2.3.4

HFM Star Schema Table Name Mapping Options

<add key="HFMAccountsAlias" value="HFM_ACCOUNT" />

<add key="HFMEntityAlias" value="HFM_ENTITY" />

<add key="HFMScenarioAlias" value="SCENARIO" />

<add key="HFMYearAlias" value="YEAR" />

<add key="HFMPeriodAlias" value="PERIOD" />

<add key="HFMICPTOPAlias" value="ICP" />

<add key="HFMCustom1Alias" value="CUSTOM1" />




19



<add key="HFMViewAlias" value="HFMVIEW" />

<add key="HFMValueAlias" value="CURRENCY" />

HFM Star Schema table name mapping reflects the dimension table names used for eachof the respective HFM dimensions. Changing the value of any of these parameterschanges the dimension table name and requires recreating the star schema from a SISSelection.

Use Auto Connection Parameter Update4.2.3.5

Use Auto Connection Parameter Update Option

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

· If set to "true", any new connection parameters is automatically be added to agiven connection

Data Value Field Length in Star Schema Fact Table4.2.3.6

Data Value Field Length in Star Schema FACT Table Option

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

· Sets the field length for data in the Star Schema FACT Table; default value is15

Extended Connection String Parameters for the SIS DB4.2.3.7

Extended Connection String Parameters for the SIS DB Option

<add key="SISDBExtendedConfiguration" value="" />

Allows extending the SIS database connection string. Any additional parameters must bepreceded and delimited with a semi-colon ";". For example, if a connection timeout valueis to be added to the SIS DB connection, add ";Connection Timeout=30;" to the value;default value is null ("").

SIS Database Configuration File Location4.2.3.8

SIS Database Configuration File Location Option

<add key="SISConfgFile" value="C:\Program Files\Star Analytics\SIS\SIS.siscfg" />

· Determines where the SIS database configuration files are located on yourhard drive

· See the Star Integration Server Client Installation Guide for more informationon the SIS Database Configuration file

Table Suffixes4.2.3.9

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 AuditTable, the HFM Process Management Table, the Planning Account Annotations Table, thePlanning Unit Annotations Table, the Planning Form Annotations Table, the Planning CellText Table and the Planning Supporting Details Table.

NOTE: The length of the FACT Table Prefix, the FACT Table name and each suffix cannotexceed 30 characters.

Essbase Security Filter Tables Suffixes 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 Essbase Filter Table, the Essbase Planning Filter Table, and the Essbase ExpandedFilter Table.

NOTE: The length of the FACT Table Prefix and each suffix cannot exceed 30 characters.

HFM Extraction parameters4.2.3.10

Suppression Option

<add key="SuppressionOption" value="9" />

values:

0=No suppression

1=Suppress rows w no data

8=Suppress rows w invalid intersections



9=Suppress rows w no data or invalid intersections

NOTE: Suppression of rows with zero data is set from the user interface.

Extraction Threads Option

<add key="ExtractionThreads" value="2" />

· Sets the number of extraction threads that control the maximum number ofrequests to the HFM API that can be outstanding at any given time

· If set to 0, the SIS sparse discovery mechanism waits for HFM to completeeach request before calculating another set of intersection points

NOTE: When set to non-zero, check the "Extraction Threads Busy" counter value in thelog file after an extraction. It counts how many times the sparse discovery mechanismhas been waiting for an extraction thread to become available. Increasing the number ofextraction threads lowers the number of times SIS waits for the HFM API to complete arequest but increase the overhead associated with running more threads.

Output Buffers Option

<add key="OutputBuffers" value="16" />

Sets the number of buffers available to the output thread. The output thread writes theextracted data to the FACT tables. The output thread allocates an array of the sizeOutput Buffers x Threshold (set by the UI) for storing output records extracted by theextraction threads. The output thread posts a batch of records to the target connectionwhen the threshold has been reached while continuing to store output records extractedby the extraction threads.

NOTE: Select the "Output Queue Full" counter value in the log file after an extraction. Itcounts how many times the extraction threads have waited for space in the output bufferto become available. Setting the number of output buffers higher decreases the blockingof the extractor threads, but increases the memory overhead.

Output Indicator Threshold Option

<add key="OutputIndicatorThreshold" value="1" />

Sets how many batches of output records is written to the target connection before thenumber of records written is shown in the status window. Setting this to a higher valuedecreases the amount of network traffic between the client and a satellite server duringan extraction.

Sparse Discovery Threshold Option

<add key="SDThreshold" value="1" />

Sets the threshold for the sparse discovery mechanism. The Accounts, ICP, Custom 1-4dimensions can be pre-processed before an extraction to avoid extracting data from



intersections with no data. There is an overhead associated with the pre-processing. It isonly beneficial when a number of members have been selected for a dimension. If only afew members of a dimension have been selected, the extraction is faster if pre-processing is turned off for that dimension. Any of the 6 dimensions is pre-processed ifthe number of members selected is greater that the SDThresHold value. SettingSDThresHold to 0 enables pre-processing for all 6 dimensions. It is possible to overridethe SDThresHold for individual dimensions by adding the keys shown below. Setting avalue for a filter to 1 enables pre-processing that dimension regardless of theSDThresHold setting. Setting the value to 0 disables pre-processing of that dimension.

<add key="FilterA" value="1" />

<add key="FilterI" value="1" />

<add key="FilterC1" value="1" />




License Key4.2.3.11

License Key Option

<add key="LicenseKey" value="12345-67890-12345-67890-ABCDEF" />

· Sets the license key; option can more easily be set from the UI

Password Persistense4.2.3.12

Password Persistence Option

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

· If set to true, the user name and password of a connection will not be saved tothe config database; user is prompted for the user name and password eachtime a connection to the source or target is needed

FACT Table Persistence4.2.3.13

FACT Table Persistence Option

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

· If set to true, the FACT table and the temporary FACT table will not bedropped and created if they exist; if set to true, the temporary FACT table willnot be dropped after a selection has been run

Audit Table Persistence4.2.3.14

Audit Table Persistence Option

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

· If set to true, the Audit table will not be dropped and created if it exists



FACT Table and Column Names Quotes4.2.3.15

Table Name Quotes Option

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

· If set to true, relational target table names will be enclosed in quotes. · If set to false, only table names that are reserved or invalid names for that particular

target database will be quoted.

Column Name Quotes Option

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

· If set to true, the columns of the following tables will be enclosed in quotes: FACTtables, HFM dimension tables, HFM Process Management table, Planning Units table,Planning Account Annotation table, Planning Cell Text table, Planning Form Annotationstable, Planning Supporting Details table.

· If set to false, only column names that are reserved or invalid names for that particulartarget database will be quoted.

Validate Member Selections Before Running SISCMD4.2.3.16

Validate Member Selections Before Running SISCMD Option

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

· If set to true, SISCMD will check the members of a selection against the actualdatabase outline before running the selection. If one or more members havebeen deleted from the outline, the run will fail. The missing member(s) will bedisplayed in the command line window and logged to the log file.

Note: Setting this option to false may speed up running a selection. Youshould only do so if you know your outline has not changed and your selectionis running with the option set to true.

HFM Data Link Path4.2.3.17

HFM Data Link Path

<add key="HFMDataLinkPath" value="" />

· Sets the absolute path to the HFM data link file. Example: "C:\Path To My HFMData Links\My Data Link Directory"

Note: If the path is set to "", the path to the install directory will be used. SeeHFM Connection Parameters for information on how to use the HFM DataLink.

65



4.3 Changing the License Key

From the SIS Manager toolbar select Help è License Key... to view the current licensekey. The license key, type of license and the licensed modules and connections will bedisplayed.

To change the license key, type the new license key and click OK. Confirm the license keyand click OK again.

The new license key is enabled immediately.

When changing from an EXPRESS license to a STANDARD or DEVELOPMENT license youneed to restart the SIS Manager.

4.4 Changing to a Different SIS Database

To change to a different SIS database select the Change Star Integration ServerDatabase from the Start Menu or select Tools è Change SIS Database... from the SISManager menu.

The Change Star Integration Server Database will show the current SIS databaseconfiguration.



To create a new database configuration click New. Type a name for the new configurationand check Use This Configuration to use the configuration next time the SIS Managerstarts. Select the database type, and type the login information for the database. It isrecommended that you test the connection to the database. Click the Test button to dothat.

Click Save to save the configuration. Click Close to close the database change tool.

To use a previously saved configuration click Open and select the configuration as shownbelow:



It is recommended that you test the connection to the database. Click the Test button todo that.

Check Use This Configuration and click Save to save the configuration. Click Close toclose the database change tool.

4.5 Updating the SIS Database

To update an existing SIS database or to create a new one select the Star IntegrationServer Database Update Tool from the Start Menu.

The Star Integration Server Database Update Tool dialog will be displayed as shownbelow:



Select the type of the database that will hold the SIS database tables.

For Microsoft SQL Server database type:

v Type the name of the server in the Server Name text box.

v Type the name of the SQL Server database in the Database Name text box

v If Windows authentication will be used to authenticate the connection to theSQL Server, check "Use SQL Server Trusted Connections"

v If native SQL Server authentication will be used, uncheck "Use SQL ServerTrusted Connections" and type the username and password in the respectivetext boxes.

v To save the password with the configuration file, check the Save Passwordcheck box. If Save Password is not checked, SIS will prompt for a passwordeach time it is run.

Before proceeding, you must test the connection to the SIS database. Click the Testbutton. After some time you should see the following dialog:



If the connection fails, check the Server Name and Database Name. Try to uncheck "UseSQL Server Trusted Connections" and enter a User Name and Password for the databaseconnection and try again.

Click OK and click the Update button to install the SIS database.

If you are updating an existing SIS database, you may see this dialog:

Click OK and click the Save button to proceed.

If you are using an Oracle database, click the 'Oracle 9.2 or greater' radio button.

v Type the Oracle database name which is the name or network address of theinstance of Oracle to which to connect.

v Type the Oracle login account to use in the 'User Name' text box.

v Type the password to use to connect to the Oracle login account in the'Password' text box.

v To save the password with the configuration file, check the Save Passwordcheck box. If Save Password is not checked, SIS will prompt for a passwordeach time it is run.



Before proceeding, you must test the connection to the SIS database. Click the Testbutton. After some time you should see the following dialog:

If the connection fails, check the Database Name, User Name, and Password and tryagain.

Click OK and click the Update button to install the SIS database.

If you are updating an existing SIS database, you may see this dialog:

Click OK and click the Save button to proceed.

4.6 Updating the Essbase Extractor

The Star Integration Server requires a Custom-Defined Function (CDF) to be installed onthe Essbase server in order to be able to extract data from a BSO cube. The CDF .jar fileand accompanying files are referred to as the Essbase Extractor.

Installing a new Essbase Extractor or updating an existing one amounts to copying filesto the Essbase server, updating Essbase server configuration files, and running a MaxLscript to install / update the CDF on the Essbase server. The process is handled by theEssbase Extractor Update Tool.

The Essbase Extractor Update Tool can be launched from the Start menu or from thedialog shown the first time the Star Integration Server in launched.



Type a valid Essbase server folder path in the Essbase Server Folder text box. UNCnames are supported as shown in the example below. The Essbase server folder is thefolder that has the app, bin, and java folders of the Essbase server.

The Update Tool will attempt to fill in the Essbase Server text box based on the EssbaseServer Folder. Make sure that the Essbase Server is the name of the Essbase server youare installing the Essbase Extractor on.

Type the user name and password of an Essbase administrative user in theAdministrative User and Administrator Password text boxes.



You may also enter the Essbase server folder by clicking the browse button as shownbelow.

Click the Update button to start installing or updating the Essbase Extractor. After theupdate has completed you will be instructed on how to proceed.

The update process depends on where your Essbase server is located relative to the Star



Integration Server and on the platform the Essbase server is installed on. Click on thelinks below for details.

Essbase server installed on the same server as Star Integration Server

Essbase server installed on a different server

Essbase server installed on a UNIX server or on a server that is temporarily notaccessible

4.6.1 Essbase server installed on the same server as SIS

The Essbase Extractor Update Tool will show the install / update steps in the statuswindow as shown below.

After the install / update has completed this dialog will be shown:

39

41

42



Click the Register button to register the CDF with Essbase. The following dialog will beshown to help you interpret the results of the registration.

The registration command window will look similar to this:



4.6.2 Essbase server installed on a different server





Click OK to view instructions for the completing installing / updating the EssbaseExtractor in Notepad.

The last part of installing / updating the Essbase Extractor is registering the CDF withEssbase. Instructions on the registration process can be found in thePostExtractorUpdateSteps.txt file in the EssbaseExtractor folder of the install directory.

4.6.3 Essbase server installed on a UNIX server

To install / update the Essbase Extractor on a UNIX server enter the Essbase serverfolder and the Essbase server name as shown in the example below.



When you click the Update button you will see this dialog:

Click Yes to proceed with the installation / update.





Click OK to view instructions for the completing installing / updating the EssbaseExtractor in Notepad.

4.6.4 Setting Hyperion Essbase Extractor Properties

Note: Do not make any changes to the SIS.properties file unless instructed by StarAnalytics personnel.

The SIS.properties file sets the properties for the Essbase Extractor. The SIS.propertiesfile is installed in the same location as the SIS Essbase Extractor and is required for theextractor to run properly. The properties are commented out by default by precedingeach property line with "#".

When editing file paths, use \\ as path separators if Essbase is installed on a Windowsserver. Use / as path separators if Essbase is installed on a UNIX server.

Edit this file using a standard text editor:

· LogFile. The absolute path and file name of the Essbase Extractor local logfile. Essbase Extractor local logging is disabled by default. Remove the "#" infront of the property to turn on logging of Essbase Extractor log messages to alocal log file.

LogFile=C:\\Hyperion\\essbase\\java\\udf\\StarAnalyticsServices.log

· SISMessaging. Use this property prevent the Essbase Extractor from sendingmessages for logging back to SIS using TCP. SISMessaging should be turnedoff if it is not possible for the Essbase Extractor to send log messages back toSIS on any port as the inability for the SIS Essbase Extractor to open a port toSIS will affect the performance. See also Selection Manager Options forhow to set the Essbase Extractor Messaging Port. Remove the '#' in front ofthe property to prevent the Essbase Extractor from sending messages forlogging to SIS.

SISMessaging=Off

· PropertiesFileLocation. This property sets the absolute path and file name

19



of this file so the Essbase Extractor can find it. Set this property if the SIS.properties file is not located at %ARBORPATH%\java\udf or %ARBORPATH%/java/udf. Note: A change to this property requires a restart of the Essbaseserver.

PropertiesFileLocation=C:\\Hyperion\\essbase\\java\\udf\\SIS.properties



4.7 Using the Connection Manager

The Connection Manager is used to create, edit, test and delete Connections. Connectionsare paths to data sources where data is extracted from and paths to targets whereextracted data is stored.

Connections to the following data sources are supported:

· Hyperion Essbase

· Hyperion Planning

· Hyperion Financial Management

Connections to the following data targets are supported:

· Microsoft SQL Server using Trusted Connection

· Microsoft SQL Server using SQL Server Login

· Oracle

· ASCII text file

See Also:

· Creating a Connection

· Connection ID

· Enabling a Connection to use Satellite Server

· Testing a Connection

· Editing a Connection

· Deleting a Connection

· Cloning a Selection

· Exporting a Connection

· Importing a Connection

· Viewing Connection Uses

· Connection Parameters

47

49

49

50

52

54

85

55

56

57

59



4.7.1 Creating a Connection

1. Select the Connection Manager node in the SIS navigation tree.

2. Either right-click Connection Manager and select New Connection or clickthe New Connection button in the right pane.

3. The Connection Editor dialog displays; select the Connection Type from thedrop-down menu before entering other connection parameter values.



4. The connection details section displays all default values for the newconnection. The parameters displayed are appropriate to the type ofconnection chosen. Refer to the following table to change the defaultconnection details to your specific connection:

· Name: Specify a meaningful Connection Name that is easy to distinguishfrom other connections

· Description: Specify a Connection Description, if desired

5. Edit the connection parameter values by clicking once on the respectiveParameter Value. Note that the password parameter field is masked forsecurity purposes.

6. If a satellite server is being used, click the Enabled for Satellite Server box.See Enable Connection for Satellite Server for additional details on using asatellite server.

7. To test a connection click Test; see also Testing a Connection .

For all connections (except SQL Server - Trusted connection and Text Fileconnection), if you leave the User Name and/or Password blank, when SIStries to use the connection you are prompted for the User Name and Password.

8. Click Save or Save and Close to keep your settings; clicking Close closes thewindow without saving your connection.

See Also:

· Essbase Connection Parameters

· Planning Connection Parameters

· HFM Connection Parameters

· SQL Server - Trusted Connection Parameters

· SQL Server - Login Connection Parameters

· Oracle Connection Parameters

49

50

60

61

65

71

72

74



· DB2 Connection Parameters

· Sybase Connection Parameters

· MySQL Connection Parameters

· Text File Connection Parameters

· Satellite Server Connection Parameters

4.7.2 Connection ID

Each connection in the List of Active Connections has its own Connection ID. Thisidentifier is used to uniquely identify a connection.

In the example below, the Connection named 'HFM Connection' has the Connection ID of3.

4.7.3 Enabling a Connection to use Satellite Server

Essbase, Planning and HFM connections may be enabled to use a Satellite Server. To dothis, select the Enabled for Satellite Server checkbox. Note that the connection nowhas a satellite icon in the upper right-hand corner of the window.

1. Select the Satellite Configuration tab.

2. Enter the Server, Port Number and then select the Protocol.

The protocol may be either TCP or HTTP (TCP is recommended). See Client-

76

77

78

79

81



Side Channel Registration for the pros and cons of TCP vs. HTTP. TheConnect to Satellite Server on Selection Only restricts the use of the satelliteserver to those times when selections are being run. Testing connections orsetting up a Selection, for example, does not use the Satellite Server if thisoption is selected. However, the Satellite Server is used when the Selection isrun. Do not select this option if a Satellite Server is to be used at all times.This may be desirable in circumstances where HFM is not installed on themachine where the SIS client is installed. In such cases, the Satellite Servershould be used for all communications with HFM.

The default port numbers for a Satellite Server is 8009 and 8010 for TCP andHTTP, respectively. Check with the administrator that installed the SatelliteServer to confirm the port numbers used, if necessary.

Note that the Connection in the List of Active Connections now has "True" inthe "SS Enabled" column and the name of the Satellite Server is shown in the"Satellite Server" column.

4.7.4 Testing a Connection

1. Select a connection from the Connection List.

24



2. Click Test, right-click on the connection and then select Test Connection orselect Connection Manager è Test Connection from the menu.

3. Click OK to confirm the test was successful.

Listing of Events Involved in Testing a Connection

1. Select the connection and then click Edit.

2. Click Test to test the connection; the results show in the bottom of thewindow.



3. If connection cannot be made, the following error displays; click OK to closethe dialog box and check the log file for further details of the failedconnection.

4.7.5 Editing a Connection




2. Click Edit, right-click on the connection and then select Edit Connection orselect Connection Manager è Edit Connection from the menu.



4.7.6 Deleting a Connection


2. Click Delete, right-click on the connection and then select DeleteConnection or select Connection Manager è Delete Connection from themenu.

NOTES:

· To delete a connection that is no longer needed, first delete the respectiveSelection(s) and then delete the connection

· To view a list of Selections that use the connection see View Connection Uses

Deleting Several Connections

1. Select the connections from the Connection List by either Ctrl-click on eachconnection or Shift-click to select a range of connections.

2. Click Delete, right-click on the connection and then select DeleteConnection or select Connection Manager è Delete Connection from themenu.

NOTE: A connection cannot be deleted if it is used by a Selection; attemptingto do so produces the following error:

57



4.7.7 Cloning a Conection


2. Click Clone, right-click on the connection and then select Clone Connectionor select Connection Manager è Clone Connection from the menu.

4.7.8 Exporting a Connection

Connections are exported to files with a .SAC extension. Passwords within the exportedfile are encrypted.


2. Click Export, right-click on the connection and then select ExportConnection or select Connection Manager è Export Connection from themenu.

3. Enter a file name to export the connection to and then click Save.



4. Click OK to confirm the exported connection was successfully exported.

4.7.9 Importing a Connection


2. Click Import, right-click on the connection and then select Import



Connection or select Connection Manager è Import Connection from themenu.

3. Select the previously exported connection and then click Open.

4. Click OK to confirm the exported connection was successfully exported.

4.7.10 Viewing Connection Uses

View Uses lists where a connection is being used.




2. Click Uses, right-click on the connection and then select View Uses or selectConnection Manager è View Uses from the menu. The following exampleshows that a Selection with an ID of 4 is using Connection ID 2 as a SourceConnection.



4.7.11 Connection Parameters

The following tables illustrate all of the different connection types supported by SIS andeach of their parameters. Each parameter is accompanied by a description and example.

· Essbase Connection Parameters

· Planning Connection Parameters

· HFM Connection Parameters

· SQL Server - Trusted Connection Parameters

· SQL Server - Login Connection Parameters

· Oracle Connection Parameters

· DB2 Connection Parameters

· Sybase Connection Parameters

· MySQL Connection Parameters

· Text File Connection Parameters

60

61

65

71

72

74

76

77

78

79



Essbase Connection Parameters4.7.11.1

The following explains the Essbase connection parameters:

Parameter Description Example

EssbaseServer

The name of the Essbase Server MyEssbaseServer

Application Essbase Application on the Essbase Server MyEssbaseApplication

Database Essbase Database which belongs to the EssbaseApplication

MyEssbaseDatabase

Outline Essbase Outline from the Essbase Database; is almostalways the same name as the Essbase Database

MyEssbaseOutline

User Name User name for logging into Essbase used to performmetadata and data extractions; typically a user withAdmin or Supervisor privileges

MyEssbaseAdminUser

Password Password of the User Name specified ********

Note that Essbase connections may use either a local server or a Satellite Server; see Satellite Server Connection Parameters .81



Planning Connection Parameters4.7.11.2

A Planning connection consists of two parts. The first part connects to the Essbasedatabase in the same was as a regular Essbase connection. The second part connects tothe relational database (RDBMS) where the planning specific data is stored.

Note: Select the RDBMS connection type, before you configure a Planning connection.

Essbase Parameters


Essbase Server The name of the Essbase Server MyEssbaseServer

Application Essbase Application on theEssbase Server

Sample

Essbase Database Essbase Database which belongsto the Essbase Application

Basic




Outline Essbase Outline from the EssbaseDatabase; is almost always thesame name as the EssbaseDatabase

Basic

Essbase User Name User name for logging intoEssbase used to perform metadataand data extractions; typically auser with Admin or Supervisorprivileges

Admin

Essbase Password Password of the User Namespecified

********

Note that Planning connections may use either a local server or a Satellite Server toconnect to the Essbase server. See Satellite Server Connection Parameters

RDBMS Parameters, SQL Server Trusted Connection


SQL Server Name of the SQL Server MySQLServer

SQL Server Database Name of the database used as thetarget for data and metadata

MyStarSchema

Port Application port number used bythe SQL Server instance on theserver (DATA_SOURCE) specified;default port is 1433

1433

Connection Timeout Length of time (in seconds) thatSIS waits for a connection to theSQL Server; default is 15 secondsand setting the timeout value to 0allows for an infinite wait time

15

Command Timeout Length of time (in seconds) that aquery can run on the SQL Serverbefore SIS times out; default is 30seconds and setting the timeoutvalue to 0 allows for an infinitewait time

30

RDBMS Parameters, SQL Server Login Connection



Database Name of the database used as the MyStarSchema

81




target for data and metadata

Login Name Login name for the SQL Server;user typically needs sufficientprivileges to create tables, queryand load data

sa

Password Password for the login namespecified; passwords containingthe "!" character may not be usedfor Hyperion Essbase dataextractions

********

Port Application port number used theSQL Server; default port is 1433

1433

Connection Timeout Length of time (in seconds) thatSIS waits for a connection to theSQL Server; default is 15 secondsand setting the timeout value to 0allows for an infinite wait time

15

Command Timeout Length of time (in seconds) that aquery can run on the SQL Serverbefore SIS times out; default is 30seconds and setting the timeoutvalue to 0 allows for an infinitewait time

30

RDBMS Parameters, Oracle Connection


Oracle Server Name of the server where theOracle target database resides;can also be the name of a TNSname, if used

MyOracleServer

Net Service Name Oracle net service name on theOracle server; can also be thename of a TNS name, if used

MyOracleNetService

Service Name Oracle instance or service name onthe Oracle server; can also be thename of a TNS name, if used

MyOracleService

Port Application port number used bythe Oracle instance on thespecified host; default is 1521

1521

Oracle User Name Oracle user name; user shouldhave sufficient privileges to create

MyOracleUser




tables, query and load data

Oracle Password Password for the Oracle username; passwords containing "!"may not be used for HyperionEssbase data extraction

********



HFM Connection Parameters4.7.11.3

The following explains the HFM connection parameters:


HFM Server The name of the Hyperion HFM Serverrunning the HFM service. The servername can be the name of the localserver or a remote server. If the HFMserver is remote to the server runningSIS, a satellite server must be installedon the HFM server and the connectionmust be set up to connect to thesatellite server

MyHFMServer

HFM Domain HFM Domain setup by your HFMAdministrator

MyHFMDomain

HFM Application HFM Application to extract metadata ordata from belonging to the HFM serverand domain specified

MyHFMApplication

HFM AdminUser HFM user with privileges over theselected HFM application to extract dataand metadata

HFMAdminUser

HFM Password Password for the HFM AdminUserspecified

********

Alt HFM Data Link Alternate HFM database data link file. HFM_Database




SIS uses the HFM data link file toconnect to the HFM database to extractJournal Entries, Cell Line Item Details,Cell Text, and Cell History data.

For HFM versions older that 11.1.2, adata link is already configured and readyto use. In this case, the parametershould be left blank.

For HFM version 11.1.2.x, an alternatedata link to the HFM database needs tobe configured before you can use theHFM Connection. This may also be thecase in special situations where thealready configured data link is notdesirable. See below for details on howto configure an alternate data link to theHFM database.

SIS comes with a default alternate datalink file (HFM_DataLink.udl)pre-installed. It is located in the installdirectory. SIS will use that file if youleave the Alt HFM Data Link parameterblank and you're using HFM version11.1.2.x. Before you can use the defaultalternate data link file, it must beconfigured. See notes below for details.

To use a different data link file, set thisparameter to the name of the file(without the path and the .udlextension).

SIS expects alternate data link files tobe located in the install directory. Setthe HFM Data Link Path option to specifya different alternate data link filedirectory. See HFM Data Link Path fordetails.

Note: If the 'Enabled for SatelliteServer' is checked, the Alt HFM DataLink parameter specifies a data link onthe Satellite Server machine. In thiscase, configure the data link and theHFM Data Link Path on the SatelliteServer machine, not on the machinewhere the SIS Manager is installed.

30




Note that HFM connections may use either a local server or a Satellite Server; see Satellite Server Connection Parameters .

How to Configure an Alternate Datalink to the HFM Database

1) Locate the data link file 'HFM_Datalink.udl' in the install directory or create a newempty file with the extension '.udl' in the install directory.

2) Double-click on the file to open the Data Link Properties editor.

3) Click on the Provider tab and select a provider for the HFM database type. The'Microsoft OLE DB Provider for SQL Server' can be used if your HFM database is a SQLServer database. The 'Microsoft OLE DB Provider for Oracle' can be used if your HFMdatabase is an Oracle database.

81



4) Click 'Next >>'

This example is using a SQL Server database.



5)

Select a server name.Type a user name and password or select 'Use Windows NT Integrated security'.Check 'Allow saving password'.Select the HFM database in the 'Select the database on the server' drop-down combobox.



6) Click OK and 'Test Connection'.



SQL Server - Trusted Connection Parameters4.7.11.4

The following explains the SQL Server using a trusted connection:



Database Name of the database used as thetarget for data and metadata

MySQLDatabase

Port Application port number used by theSQL Server instance on the server(DATA_SOURCE) specified; default portis 1433

1433

Connection Timeout Length of time (in seconds) that SISwaits for a connection to the SQLServer; default is 15 seconds andsetting the timeout value to 0 allows foran infinite wait time

15

Command Timeout Length of time (in seconds) that aquery can run on the SQL Server beforeSIS times out; default is 30 secondsand setting the timeout value to 0allows for an infinite wait time

30



SQL Server - Login Connection Parameters4.7.11.5

The following explains the SQL Server using SQL Server login connection parameters:



Database Name of the database used as the targetfor data and metadata

MySQLDatabase

Login Name SQL Server user to login into thespecified database; user typically needssufficient privileges to create tables,query and load data

sa

Password Password for the Login Name specified;passwords containing the "!" charactermay not be used for Hyperion Essbasedata extractions

*****

Port Application port number used by the SQLServer; default port is 1433

1433

Connection Timeout Length of time (in seconds) that SISwaits for a connection to the SQL Server;default is 15 seconds and setting thetimeout value to 0 allows for an infinitewait time

15

Command Timeout Length of time (in seconds) that a querycan run on the SQL Server before SIS

30




times out; default is 30 seconds andsetting the timeout value to 0 allows foran infinite wait time



Oracle Connection Parameters4.7.11.6

The following explains the Oracle connection parameters:


Oracle Server Name of the server where the Oracletarget database resides; can also bethe name of a TNS name, if used

MyOracleServer

Net Service Name Oracle net service name on the Oracleserver

MyOracleService

Service Name Oracle instance or service name onthe Oracle server

MyOracleServiceName

Port Application port number used by theOracle instance on the specified host;default port is 1521

1521

User Name Oracle user name; user should havesufficient privileges to create tables,query and load data

MyOracleUser

Password Password for the Oracle user name;passwords containing "!" may not beused for Hyperion Essbase dataextractions

********

Connection Timeout Length of time (in seconds) that SISwaits for a connection to the Oracle

15




Server; default is 15 seconds andsetting the timeout value to 0 allowsfor an infinite wait time

Command Timeout Length of time (in seconds) that aquery can run on the Oracle Serverbefore SIS times out; default is 30seconds and setting the timeout valueto 0 allows for an infinite wait time

30



DB2 Connection Parameters4.7.11.7

The following explains the DB2 connection parameters:


DB2 Server DB2 Server Name MyDB2Server

DB2 Database DB2 Database name MyDB2Database

DB2 Schema DB2 Schema name. The 'User ID' willbe used as the schema name if thisfield is left blank.

FPWD

Port DB2 Server port number used 50000

User ID User login ID db2admin

Password Password for the given user ID ********

Connection Timeout The time, in seconds, in which theDB2 Server will cancel a connectionrequest if a connection cannot bemade within this amount of time.

30

Command Timeout The time, in seconds, in which DB2Server will cancel a query if notcompleted within this amount of time.

30



Sybase Connection Parameters4.7.11.8

The following explains the Sybase connection parameters:


Sybase Server Sybase Server name MySybaseServer

Sybase Database Sybase Database name MySybaseDatabase

Port Sybase Server port number used. 5000

User ID User login ID sa


Connection Timeout The time, in seconds, in which theSybase Server will cancel aconnection request if a connectioncannot be made within this amount oftime.

30

Command Timeout The time, in seconds, in which theSybase Server will cancel a query ifnot completed within this amount oftime.

30



MySQL Connection Parameters4.7.11.9

The following explains the MySQL connection parameters:


MySQL Server MySQL Server name MySQLServer

MySQL Database MySQL Database name MySQLDatabase

Port MySQL Server port number used. 3306

User ID User login ID root


Connection Timeout The time, in seconds, in which theMySQL Server will cancel a connectionrequest if a connection cannot bemade within this amount of time.

30

Command Timeout The time, in seconds, in which theMySQL Server will cancel a query ifnot completed within this amount oftime.

30



Text File Connection Parameters4.7.11.10

The following explains the text file connection parameters:


Data File Path and Name Full path and file name of the targetdata output file.

For Essbase extractions usingextraction type I and III, the outputpath is seen from the server whereEssbase is running and the pathmust exist. For Essbase extractionsusing extraction type II or IV, theoutput path is seen from the serverwhere SIS is running. If Essbase isrunning in a UNIX environment,change the file path to be a fullyqualified mount point and then thecorresponding user directories wherethe text output should be placed.The UNIX service account that runsEssbase must have write access tothe directory where the output textfile is placed and is relevant forEssbase extractions only.

C:\MyDataFile.txt




Delimiter Delimiter to be used in the data andmetadata files:

· Type TAB or \t to insert a tabcharacter

· Type SPACE or \s to insert aspace character

,

Metadata Path Path where metadata output isplaced. The path is always seenfrom the server where SIS isinstalled. UNC paths are alsosupported.

C:\

Column Headers Type YES to include column headersin the FACT tables, NO to leavethem out

YES

Metadata Column Headers Type YES to include column headersin the metadata tables, NO to leavethem out

NO

ID Column Type YES to include an ID column inthe FACT tables, NO to leave it out

YES

Metadata ID Column Type YES to include an ID column inthe metadata tables, NO to leave itout

NO

Character Encoding FACT and metadata text filescharacter encoding. Values areASCII, UNICODE,BIGENDIANUNICODE, UTF8.

Note: This parameter only appliesto

· Essbase Type II and IV dataextractions

· HFM data extractions

· Metadata extractions

UTF8



Satellite Server Connection Parameters4.7.11.11

The following explains the Satellite Server connection parameters:


Server Satellite Server Name MyEssbaseServer

Port Number Default port numbers for a SatelliteServer are 8009 and 8010 for TCPand HTTP, respectively

8009

Protocol TCP or HTTP TCP

See Also:

· Enabling a Connection to use Satellite Server 49



4.8 Using the Selection Manager

The Selection Manager is used to create selections of the source and the target to beused in an extraction, as well as the type of metadata or data to be extracted. To openthe Selection Manager, click on Selection Manager in the SIS navigation tree:

The following list provides links to topics describing how to manage Selections:

· Creating a new Selection

· Setting Extraction Options

· Opening (Editing) a Selection

· Deleting a Selection

· Cloning a Selection

· Importing a Selection

Three Selection types are supported:

· Essbase Selections

· Planning Selections

· Hyperion Financial Management (HFM) Selections

See Also:

· Essbase Selection Configuration

· Planning Selection Configuration

· HFM Selection Configuration

· Running a Selection

4.8.1 Creating a new Selection

Before you create a new Selection, make sure that you have created the source and thetarget Connections to be used by the Selection.

To create a new selection click New Essbase Selection, New Planning Selection or

82

88

83

84

85

86

105

114

114

121



New HFM Selection of the Selection Manager. If you click New Essbase Selection, thefollowing displays:

Type a meaningful name for the Selection in the Selection Name text box. Additionally,you may attach a description to the Selection, if desired.

If you are using the Limited Edition of SIS, the check-box 'Enable this selection forAutomation (SISCMD)' is visible. Select the check-box if you want to be able to run thisSelection from the SISCMD command line interface. See Using the SIS Command Line.

Choose the source and target connections to be used by the Selection. When you selectthe source connection, SIS attempts to load the outline from the connection. This maytake some time depending on the size of the outline.

To complete the Selection, set the Extraction Options and Selection Configuration.

See Also:

· Setting Extraction Options




4.8.2 Opening (Editing) a Selection

1. Select a selection from the Selection Manager.

127

88

105

114

114



2. Click Open, right-click on the selection and then select Open or selectSelections è Open from the menu.

4.8.3 Deleting a Selection

1. Select one or more selections from the Selection Manager.

2. Click Delete, right-click on the selection and then select Delete or selectSelections è Delete from the menu.



NOTE: For data integrity purposes, the Selection metadata in the SIS Database is notphysically deleted. The Selection record is simply flagged as deleted and can no longerbe used through SIS. However, the metadata of the Selection remains so that it can stillbe referenced from an auditing perspective for its run history.

4.8.4 Cloning a Selection

1. Select one or more selections from the Selection Manager.

2. Click Clone, right-click on the selection and then select Clone or selectSelections è Clone from the menu.

3. Click Yes to clone the selection(s).

1. Click OK to confirm the successful cloning; a new selection opens or if morethan one selection was cloned, the last cloned selection opens.



4.8.5 Importing a Selection

SIS provides for importing Selections from a file created by a SIS export. Importing aSelection assumes that the desired source and target connects already exist. To create aconnection or import connections, see Using the Connection Manager . A future versionof SIS provides for exporting and importing Selections and their related connections in asingle operation.

1. Click Import on the Selection list view toolbar or right-click on the Selectionsicon in the SIS explorer view and select Import Selection from the contextmenu.

The Import Selection dialog is displayed where the location of the Selection file(*.SAS) is located. In addition to specifying the file location, the existingsource and target connections for this Selections must be specified in the Linkto the following connections section of the dialog. Ensure that the correct typeof source connection is specified (Essbase or HFM) for the Selection to beimported.

46



2. Once the location of the Selection file has been specified and the source andtarget connections have been selected, click OK to import.

4.8.6 Exporting a Selection

Selections are exported to files with a .SAS extension. Any passwords within theexported file are encrypted.

1. Select a Selection from the list of Selections in the Selection Manager list view,right-click on the Selection row header and select Export.

This launches the Selection Export dialog which provides for specifying theexport location and file name. In addition to exporting the Selection, therelated source and target connections can optionally be exported as well:

2. Once the export location(s) has been specified, click OK to export theSelection and Connections, if applicable. A standard Windows dialog boxallows you to save the exported connection.



4.8.7 Setting Extraction Options

To set the Extraction Options of a Selection, click the Option Tabs and select the desiredsettings.

See Also:

· Selection Information

· Star Schema Options

· Metadata Extraction Options

· Data Extraction Options

· Planning+

Selection Information4.8.7.1

The following shows the Selection Information options:

The table below describes each of the Selection Information options available forEssbase, Planning and HFM Selections

Option Description Essbase,Planning

HFM

Selection Name The name used to identify theselection

X X

88

89

94

96

104




HFM

Description Optional description and notes X X

Source Connection The source connection used by thisSelection. Select a connection fromthe drop down list of previouslyconfigured connections. The outlineof the Essbase, Planning of HFMapplication will automatically beretrieved and displayed once asource connection has beenselected.

X X

Target Connection The target connection used by thisSelection.

X X

See Also:




Star Schema Options4.8.7.2

The following shows the Star Schema Options:

105

114

114



The table below describes each of the Star Schema Options available for Essbase,Planning and HFM Selections.

Option Description Essbase,

Planning

HFM

Create StarSchema

This option is only available for RDBMS targetconnections. If selected, SIS will create thedimension (metadata) tables and the FACT tablebefore extracting metadata and data. If the tablesalready exist they will be dropped and recreated.The dimension tables will only be (re)created ifmetadata extraction is selected. The FACT table willonly be (re)created if data extraction is selected.

X X

FACT TableName

The name of the FACT table where data is extractedto. The name will be pre-fixed with the StarSchema Prefix.

X X

Star SchemaPrefix

A prefix to be given to all of the star schema tablescreated with this Selection, allowing for multiplestar schemas to be extracted to the same database.The recommended naming convention is a shortprefix followed by an underscore, for example,ABC_.

X X

FACT TableFormat

This option determines the layout of the FACTtable:

· If the Narrow format is selected, the FACT tablecolumns consist of one column for each dimensionplus one column for data and one column for theaudit ID. For Essbase and Planning it is possibleto select the dimension to be included in the FACTtable.

· If the Wide format is selected, the FACT tableconsists of one column for each dimension except

X X




Planning

HFM

for the Wide dimension, columns for each Widedimension member selected as part of theMember Selection, and a column for the audit ID.For Essbase and Planning it is possible to selectthe dimension to be included in the FACT table.

For HFM selections, the Wide dimension is alwaysthe period dimension

For Essbase selections, the Wide dimension is thesame as the Spin Dimension .

An example of the Wide format, if the memberselection for an HFM selection consists of Jan andFeb, the FACT table consists of data columns of"Jan" and "Feb".

The Wide format can significantly reduce thenumber of records stored in the target connectiondetermined by the number of Wide dimensionmember selected. For example, if Jan through Decis selected as the Wide dimension, the Wide formatwill produce one record for every twelve under theNarrow format.

See the Narrow Format FACT Table andWide Format FACT Table in Appendix Afor the table formats.

Extract EntityParentMembers toFACT table

HFM has 12 fixed dimensions. EntityParent can bethought of as a 13th HFM dimension. Since thesame Entity member can exist in multiple locationsof the Entity hierarchy with potentially differentparents and different values, EntityParent isimportant in extracting and identifying unique datavalues.

When this option is selected, the EntityParent valuefor each Entity member is exported to the targetconnection. For all target connections, a new field isadded to the FACT table for the EntityParent value.

X

FACT TableMemberValues

This option determines the format of thedimension column values of the FACT table.

If set to Use Member Names the valueswill be the names of the members. Thedimension column values in the FACT table

X X

109

172

172




Planning

HFM

are text strings which inherently take upmore hard disk space and are slower toquery when joined with the dimensiontables.

If set to Use Member ID Reference thevalues will be an ID that references the IDof the member in the related dimensiontable. The IDs are integers which take upmuch less space and have faster querytimes than text strings.

See the Use Member ID ReferenceIllustration below for more information.

Use Member ID Reference is not validwhen using a text file target.

DimensionTable Layout

This option determines the format of the metadatatables.

· Parent / Child

· Balanced Hierarchy: The Translation table allowsyou to specify specific name for each dimension'sgeneration. These names are used as therespective dimension table's column names foreach generation.

· QlikView Layout (Essbase only).

· Master Data Management

MDM Version: Master Data Manager VersionNumber for MDM Metadata Exports

See Parent/Child Format , Generation (BalancedHierarchy) Format , and Master DataManagement Format

X X

93

152

152

154




Planning

HFM

Max. UDAs Sets the maximum number of UDA columns in theEssbase dimension tables. See Essbase DimensionTables .

X

Use Member ID Reference Illustration

Using the Hyperion Essbase Sample Basic application, a Selection was created with the"Use Member ID Reference" option selected. With this option, the FACT table was createdwith integer data types for the dimension columns. During the data extraction, the IDvalue from the related dimension table was "looked up" and used in the respectivedimension column of the FACT table.

In the following screen shot, one record is loaded into the FACT table where the Yearcolumn has a member ID reference of 16 which corresponds to the record in the Yeardimension table with the ID of 16 which is the member "Dec".

155



See Also:




Metadata Extraction Options4.8.7.3

The following shows the Metadata Extraction Options:

105

114

114



The table below describes each of the Metadata Extraction Options available for Essbase,Planning and HFM Selections.


HFM

Extract Metadata Select this option to extract metadata to therespective dimension tables. For Essbaseand Planning, metadata will only beextracted for the dimensions selected inthe Essbase Column Selections .

X X

Extract Users Select this option to extract Essbase Usersdata. If this option is selected, the EssbaseUser table will be generated.

See Essbase Users Tables for details.

X

Extract UserGroups

Select this option to extract Essbase UsersGroups data. If this option is selected, the EssbaseUserGroup table will begenerated.

See Essbase Users Tables for details.

X

Extract Filters Select this option to extract Essbase filtersdata. If this option is selected, the EssbaseFilter table will be generated.

See Essbase Filters Tables for details.

X

Extract ExpandedFilters

Select this option to extract EssbaseExpanded Filters data. If this option isselected, the ExpandedFilter table will begenerated.


X

Extract PlanningFilters

Select this option to extract Essbase X

109

179

179

177

177




HFM

Planning Filters data. If this option isselected, the PlanningFilter table will begenerated.


See Also:




Data Extraction Options4.8.7.4

The following shows the Data Extraction options:

Essbase and Planning Data Extraction Options

HFM Data Extraction Options

177

105

114

114



The table below describes each of the Data Extraction Options available for Essbase,Planning and HFM Selections.


HFM

Extract Data Select this option to extract Essbase or HFMdata to the FACT table.

X X

Data Precision Specifies the number of decimal places theextracted data will be rounded to.

X X

Record Commit Specifies the number of extracted data recordsthat will be held in memory before they arecommitted to the target connection. Forexample, if the target connection is SQL Serverand the Record Commit level is 1000, recordsare written to the SQL Server in blocks of1000.

NOTE: This option can help with dataextraction performance. A higher RecordCommit may boost the performance bylowering the number of database accesses.However, a high record commit requires morememory on the SIS server for intermediatestorage.

X X

Load Type Specifies how data is written to the targetconnection. The options are as follows:

X X




HFM

· Merge: The extracted data records aremerged with existing records. This option isnot supported for Text File target connections

· Refresh: All data records in the targetconnection is deleted and replaced with thedata records from the Selection data

· Append: Data records from the Selection isappended to the target data source andexisting data is not affected

Suppression Provides options for suppressing intersectionpoints:

· Suppress Zeros (Essbase and Planningselections only): Intersection points withdata values of zero (after rounding up to thespecified data precision) will not beextracted.

· No Suppression (Essbase and Planningselections only): All intersection points willbe extracted.

· Suppress Missing: All data points that are#Missing or NULL will not be extracted.

· Suppress Zeros and Missing: CombinesSuppress Zeros and Suppress Missingoptions.

· Suppress Shared Entity Members (HFMselections only): Suppresses extractingduplicate Entity Member data intersectionpoints from HFM where the Entity name andParent name are the same. The same Entityname with two different parents is stillextracted. This option is only enabled if Extract Entity Parent members to FACT tableis checked.

· Suppress Dynamic Accounts Members(HFM selections only): No intersection pointwhere the Accounts member is dynamic willbe extracted. Selecting this option will insome situations significantly boost theextraction performance.

· Suppress Relative Parent EntityMembers (HFM selections only): Suppressesextracting data from intersection points from

X X




HFM

HFM where the Entity member's parent is notthe default entity parent.

Intelligent Extract Provides for extracting only data that havechanged since the last extraction.

SIS examines the clean/dirty flags on Essbaseblocks to extract the data from dirty blocks.

Only available for Essbase extractiontype I.

Checking Set data as clean will set the datablocks to clean after the extraction.

Available for Essbase extraction types Iand III.

See Intelligent Extraction for moreinformation.

X

Extract StoredMembers Only

Set this option to leave out dynamic membersfrom the extraction.

Not available for Essbase extractiontype II and type IV.

X

Set Data as Clean Sets extracted data blocks to clean.


X

Use Alias If set, member aliases will be extracted to thetarget connection FACT table rather than themember names. This option has no effect if theFACT Table Member Values option is set to UseMember ID Reference.

If using Extraction type III and a TextFile target the exported dimensionvalues will be member names.

X

Implicit ShareOverride

Settings:

· OFF· PARENT-CHILD· UDA· GENMBRS

X

8




HFM

· LEVMBRS

As part of its optimization process, Essbase willimplicitly remove parent members that onlyhave a single child member. In the outlinebelow, data extracted from products 500,500-10, 500-10-10 will all show up in theoutput as if coming from 500-10-10-10.

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

As an example, to produce the correct output ifproduct 500-10 is selected, there are threeoptions to choose from. 1) Select the UDA setting and specify@UDA(Product,"Real Beer") in the CustomScope Control below.2) Select the GENMBRS setting and specify@GENMBRS(Product,3) in the Custom ScopeControl below.3) Select the LEVMBRS setting and specify@LEVMBRS(Product,2) in the Custom ScopeControl below.

This option only applies to Essbaseextraction type I.

Extract ProcessManagement Data

If selected, Process Management Data isextracted from members selected in theMember Selections window.

X

Extract JournalEntries

If selected, Journal Entries are extracted eitherfrom members selected in the MemberSelections window or all Journal Entries for theHFM application are extracted.

X

Extract Cell LineItem Details

If selected, Cell Line Item Details are extractedeither from members selected in the Member

X




HFM

Selections window or all Cell Line Item Detailsfor the HFM application are extracted.

Extract Cell Text If selected, Cell Text is extracted either frommembers selected in the Member Selectionswindow or all Cell Text for the HFM applicationis extracted.

X

Extract CellHistory

If selected, Cell History is extracted either frommembers selected in the Member Selectionswindow or all Cell History for the HFMapplication is extracted.

X

Memory Cache Contains a valid value between 1 and 200kilobytes and is used to control the amount ofmemory used the HFM Data Extractor whenbatching data intersection requests beforesubmitting them to the HFM API.

The higher this memory setting, the more dataintersection points that can be batched withinSIS before calling HFM for the data points.This, in turn, can significantly improveperformance with HFM Data Extractions.

See Optimized HFM Data Extraction formore information.

X

Custom DataValue Filter

Custom Data Value Filtering limits the EssbaseSelection output based on standard Essbase IFcondition syntax. Custom Data Value Filteringis similar to the Member Selection CustomCalculation functionality, but at the Selectionlevel rather than at the member selection level.For example:

Filters out data less than 1000:

Returns data between 200 and 1000:

X

12




HFM


Custom ScopeControl

Custom Scope Control provides alternate wayof entering member selection criteria inaddition to the functionality provided by theSIS Selection Manager.

For example, using the Sample Basicapplication, to select all members of the Marketdimension that are tagged with the UserDefined Attribute (UDA) of 'Major Market', add'@UDA(Market, "Major Market")' to thecontrol.

The control is also used in conjunction with theImplicit Share Override feature. See theImplicit Share Override option above fordetails.

Not available for Essbase extractiontype II and type IV.

X

Extraction type Sets the extraction type.

· Type I: SIS standard extraction type. Thisextraction type offers the highest flexibilityand feature set.

· Type II: An alternate extraction type that insome cases will yield a much higherperformance. This option is only available

X




HFM

when connected to an Essbase server with aversion number higher than or equal to 7.x.

· Type III: A new high-speed extraction type.This option is only available when connectedto an Essbase server with a version numberhigher than or equal to 9.3.

· Type IV: A new high-speed extraction typethat in most cases will offer higherperformance than type II.

· Note: Type II and IV are the only extractiontypes available for extracting data from anASO application.

See Choosing the right Essbase ExtractionType for details.

Buffer size Sets the size of the internal buffer. This settingshould be left at its default of 'Auto'.

Setting the buffer size too low may result inlonger extraction times. Setting the buffer sizetoo high may result in the Essbase serverbecoming non-responsive.

SIS will calculate an appropriate buffer size ifthe 'Buffer size' is set to 'Auto' based on theperformance of the machine SIS is running onand the members selected. The actual buffersize that SIS is using is recorded in the SIS logafter each data extraction. It is recommendedto use that buffer size as a starting point if itbecomes necessary to change the default'Buffer size'.

For very large and extremely sparse databasesit may be advantageous to set the 'Buffer size'to a larger value than the one chosen by SISwhen using type IV extraction type.

Only available for Essbase extraction type IIand type IV.

X

Extraction threads Sets the maximum number of extractionthreads used during an extraction.

Only available for Essbase extractiontype II and type IV.

X

112




HFM

Lock databaseduring extraction

Check this option to prevent updates to theEssbase database during extraction.

Only available for Essbase extractiontype II and type IV.

X

See Also:




Planning+4.8.7.5

The following shows the Planning+ Options:

The table below describes each of the Planning+ Options available. Planning+ options areonly available for Planning Selections.

Option Description

Extract Planning Details Enables the extraction of Planning Details data.

Account Annotations Extracts Account Annotations.

Cell Text Extracts Cell Text.

Supporting Details Extracts Supporting Details.

Planning Unit Annotations Extracts Planning Unit Annotations.

Form Annotations Extracts Form Annotations.

See Also:

105

114

114






4.8.8 Configuring an Essbase Selection

Configuring an Essbase Selection consists of setting the extraction options , setting theColumn Selections, and selecting one or more members from the Essbase outline toextract if the data extraction option is selected.

Click the links below for details on the usage of the Essbase Selection Outline, ColumnSelections, and Member Selections sections.

· Selecting Members From an Essbase Outline

· Essbase Column Selections

· Essbase Member Selections

Selecting Members From an Essbase Outline4.8.8.1

To select a member from an Essbase Outline right-click on the member and select amember selection function. For some function types it is possible to specify an inputparameter to the function. The input parameters available depend on the actual outline.

Some members may not allow all functions to be selected depending on their position inthe outline, e.g. top members will have the ancestors functions disabled. If extractiontype I is selected, only level 0 members of the spin dimension can be selected.

Expand the outline by clicking on the + sign to the left of the nodes of the outline to findthe desired member. Alternatively, use the search function to search for a member. Click here for details on the outline search capability.

The example below uses Sample Basic to illustrate selecting a member. It shows how toselect the descendants and member of Profit down to and including all level 2 membersbelow Profit.

105

114

114

88

105

109

110

121



Here is the Member Selections section before the selection:

Here is the Member Selection section after the selection. The newly selected member ishere shown as the top row.

To remove a selected member, right-click on the member name and select RemoveMember. To remove more than one member selection at a time, click the row header tabto the left of the Member column of the members to be deleted while holding down the<ctrl> key and then right-click on the Member column of one of the selected membersand select Remove Member.



To locate a member in the outline tree, right-click on the member name and selectLocate Member. The Essbase outline tree will be opened on the selected member.

Selecting Members From a List of Essbase Members4.8.8.2

As an alternative to selecting Members from the outline tree, SIS offers the ability toselect members from a list of all members of an outline.

To open the member list selection dialog, click on the drop-down arrow next to the AddMember button and select Add Members From List...

Select a member from the Member drop-down list and select a Function and a Parameteras described in the section Selecting Members From an Essbase Outline and clickAdd.

Click Done to close the dialog.

Selecting Server-Side Substitution Variables4.8.8.3

SIS offers the ability to select members from substitution variables defined on theEssbase server.

To open the server-side substitution variables selection dialog, click on the drop-downarrow next to the Add Member button and select Add Server-Side SubstitutionVariables...

105



Select a substitution variable from the Variable drop-down list and select a Function anda Parameter as described in the section Selecting Members From an Essbase Outlineand click Add. Repeat the process to add more substitution variables.

Click Done to close the dialog when you're done adding substitution variables.

The values of the substitution variables supported by SIS are:

· A single member e.g. 100-10

· A list of members e.g. 100-10, 200, 300, 400-10

· A level range e.g. Sep:Dec which resolves into Sep, Oct, Nov, Dec, allmembers with the same level

· A generation range e.g. Qtr2::Qtr4 which resolves into Qtr2, Qtr3, Qtr4, allmembers with the same generation

· A combination of the above e.g. 100:300, 100-10, 200-20

Notes:

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

SIS only supports members from the same dimension in the same substitution variable.

The name of the substitution variable will be prefixed with an ampersand in the MemberSelections section to distinguish it from outline members.

When searching the outline for a substitution variable, the member that the variableresolves into will be found.

For substitution variables that resolve into more than one member:

- The Function will be set to 'Select Member'.- If a Custom Name is entered, only the first member will be given the custom name.- When searching the outline for a substitution variable, the first member will be found.

105



Essbase Column Selections4.8.8.4

The following shows the Essbase Column Selections:

The table below describes each column of the Essbase Column Selections and their uses.

Column Description

Export Selects a specific dimension to be extracted during MetadataExtraction. The Export checkbox also selects the dimensions thatwill be included in the FACT table.

If using Extraction type III and a Text File target, the valuesof dimension columns of attribute dimensions will be empty.

Column Lists all dimensions of the outline.

Spin See Section 2.4.8.1.1 Spin Dimension

MDM Prefix When extracting metadata in MDM format, this field allows you toenter a prefix for the member names for an MDM-ready format.

Sort This setting controls the ordering of the dimension columns in theFACT table. The leftmost column will be the one with a Sort value of0. Values must be zero-based and no larger than the number ofdimensions minus one.

Spin Dimension4.8.8.4.1

The Spin Dimension is a concept unique to Hyperion Essbase and Planning Selections. Itis used when extracting data from the multi-dimensional Essbase database to the twodimensional row-column relational database or flat file.

Type I Data Extraction

SIS will for each selected member of the Spin Dimension extract a block of data based onthe member selections of the other dimensions and the data extraction options settings.If no stored members of the Spin Dimension are selected, all stored level zero members(leaf nodes) of the Spin Dimension is used in the extraction.

To optimize the performance of the data extraction care must be taken when selecting aSpin Dimension. As a rule, select a dense dimension with the least amount of level zero

109



members for best performance.

Only level zero members of the Spin Dimension can be selected. See Selecting MembersFrom an Essbase Outline .

Type II Data Extraction

For best performance select a sparse dimension. Any members of the Spin Dimensioncan be selected.

Type III Data Extraction

Select a dense dimension. Any members of the Spin Dimension can be selected.

Essbase Member Selections4.8.8.5

The following shows the Essbase Member Selections:

The table below describes each column of the Essbase Member Selections and their uses.

Column Description

Member Name of the selected member.

Function Member Selection Function selected for the currentmember. Right-click on the Function of a selected memberto change the Member Selection Function and possibly theinput parameter to the function.

Parameter Input parameter to the selected Function.

Custom Name Used to specify a custom name for the currently selectedmember. The custom name replaces the actual membername in the CUSTOM_NAME field of the respectivedimension table and in the dimension columns of the FACTtable. Note that only member selections of function type'Select Member' can have a custom name.

Custom Calc Check the custom calc check box to enable customcalculation for a selected member. See explanation below

105



Column Description

on custom calculations.

Custom calculations are only available for extraction type Iand only for members of the spin dimension.

Dimension Dimension to which the selected member belongs.

Custom Calculations

SIS allows you to specify a custom calculation for a leaf node member of the spindimension. The custom calculation definition window is shown below the Essbase Outlinewhen the Custom Calc check box is selected.

Enter a custom calculation function against the respective member selection using thesame syntax as in preparing the right-hand side of a calculation in an Essbase Calc Scriptin this box. For example, for the Jan member selection, an increase of 20% can beapplied by entering a formula such as 'Jan * 1.2'.

To help with specifying the correct syntax and spelling of member names, a user can



right-click on any member in the Selection outline and select one of the customcalculation options. For example, to add "Sales" to the existing custom calculation, locatethe Sales member in the outline, right-click and select "Add to Custom Calc"

Choosing the right Essbase Extraction Type4.8.8.6

The Star Integration Server provides four extraction types as well as several options forextracting data from Essbase BSO (Block Storage) and Essbase ASO (Aggregate Storage)models. This section is designed to provide guidance as to when each method should beused and with the applicable options.

For Essbase ASO models only extraction Type II and Type IV are available.

For Essbase BSO models all extraction types are available. There are many variables thatneed to be considered in order to choose the right type. If there is a need to extract alarge portion of the database (more than 10,000,000 intersection points or if thedatabase is sparsely populated) then Type I, III, or IV would typically outperform TypeII.

If there is a need to extract data with many dynamic calculations from both dense andsparse dimensions then Type II or Type IV may be the best choice.

If there is a need to perform ‘Intelligent Extraction’ (change data capture) from anEssbase cube then Type I is the only choice.

The following table can help clarify the differences and when best to use Type I, II, III, orIV.

Lastly, since Essbase cubes and their internal structure vary so much, often times theonly way to get the best performance is to simply experiment.

X = supported.

Feature /Option

Relational Target Text file Target

Type I Type IITypeIII

TypeIV

Type I Type IITypeIII

TypeIV

ASO Extraction X X X X

BSO Extraction X X X X X X X X

Set Output DataPrecision

X X X X X X X X

Set RecordCommit

X X X X X X X X

Set Load TypeAppend

X X X X X X X X

Set Load Type X X X X X X X X



Refresh

Set Load TypeMerge

X X X X X

Extract Datawith Aliases

X X X X X X X

Implicit ShareOverride

X X X X

IntelligentExtraction

X X

Custom DataValue Filter

X X

Custom ScopeControl

X X X X

Set ExtractionBuffer

X X X X

Set ExtractionThreads

X X X X

Essbase ServerSide Export

X X X X

Client SideExport

X X X

SQL Server BulkInsert

X X N/A N/A

Ideal CubeExtracton Space

Unlimited 10,000, 000 orless

Unlimited Unlimited Unlimited 10,000, 000 orless

Unlimited Unlimited

Extraction of aSparse Cube /Intersection

X Yes -poorperf.

X X X Yes -poorperf.

X X

Extration ofDynamicCalculations

Yes -DenseOnly

X Yes -poorperf.

X Yes -DenseOnly

X Yes -poorperf.

X

Essbase versionsupported

6.5 andabove

7.0 andabove

9.3 andabove

7.0 andabove

6.5 andabove

7.0 andabove

9.3 andabove

7.0 andabove



4.8.9 Configuring a Planning Selection

Configuring a Planning Selection consists of configuring an Essbase Selection and settingthe Planning+ specific extraction options.

For details on configuring an Essbase Selection click here . Note that it is not necessaryto configure any Essbase column or member selections if only Planning Details extractionis selected.

For details on setting the Planning+ specific options, click here .

4.8.10 Configuring an HFM Selection

Configuring a Hyperion Financial Management (HFM) Selection consists of setting theextraction options and selecting one or more members from each dimension of theHFM outline to extract if the data extraction option is selected.

Click the links below for details on the usage of the HFM Selection Outline, ColumnSelections, and Member Selections sections.

· Selecting Members From an HFM Outline

105

104

88

115



· HFM Column Selections

· HFM Member Selections

Selecting Members From an HFM Outline4.8.10.1

To select a member from an HFM outline right-click on the member and select a memberselection function.

Some members may not allow all functions to be selected depending on their position inthe outline, e.g. top members will have the ancestors functions disabled.

Expand the outline by clicking on the + sign to the left of the nodes of the outline to findthe desired member. Alternatively, use the search function to search for a member. Click here for details on the outline search capability.

The example below uses the Comma application to illustrate selecting a member. Itshows how to select the level 0 members below the Budget member.

Here is the Member Selections section before the selection:

119

120

121



Here is the Member Selection section after the selection. The newly selected member ishere shown as the bottom row.

To remove a selected member, right-click on the member name and select RemoveMember. To remove more than one member selection at a time, click the row header tabto the left of the Member column of the members to be deleted while holding down the<ctrl> key and then right-click on the Member column of one of the selected membersand select Remove Member.



To locate a member in the outline tree, right-click on the member name and selectLocate Member. The HFM outline tree will be opened on the selected member.

Selecting Members From an HFM Member List4.8.10.2

SIS offers the ability to select members from member lists defined on the HFM server.

Separate member lists are defined for each dimension. To see the member lists definedfor a dimension, right-click on the outline on any member of the dimension and selectthe 'Select Members from member list' menu item.



To select all members from a member list, double-click on the member list or select themember list and choose All.

All members from the member list will be included in the member selection when theselection is run. The members used is based on the member list definition at the time theselection is run.

Note: The name of the member list will be prefixed with an ampersand in the Member



Selections section to distinguish it from outline members, as shown below.

To select individual members from a member list, select the member list and choose'Select Members'. The member selection dialog will be shown. Add members from the'Member' drop-down list, one at a time. When done, click 'Done'.

HFM Column Selections4.8.10.3

The following shows the HFM Column Selections:

The table below describes each column of the HFM Column Selections and their uses.



Column Description

Column Name of the dimension.

Output Name Dimension output name. The output name is used as the dimensioncolumn name in the FACT table and as the name for each dimensiontable. The mapping of dimension names to output names isdetermined by the config file settings. See also HFM Star SchemaTable Name Mapping .

MDM Prefix When extracting metadata in MDM format, this field allows you toenter a prefix for the member names for an MDM-ready format.

Sort This field controls the ordering of columns in the FACT table. Theleftmost column will be the one with a Sort value of 0. Values mustbe zero-based and no larger than the number of dimensions minusone.

HFM Member Selections4.8.10.4

The following shows the HFM Member Selections:

The table below describes each column of the HFM Member Selections and their uses.

Column Description

Member Name of the selected member.

Function Member Selection Function selected for the current member.Right-click on the field to change the Member Selection Function.

Custom Name Used to specify a custom name for the selected member. TheCustom Name replaces the actual member name in theCUSTOM_NAME field of the respective dimension table and in the

25



Column Description

FACT table.

Dimension Displays the dimension to which the selected member belongs.

4.8.11 Searching for Outline Members

To search for a specific member in an outline, enter the name or a part of the name inthe Search Box above the outline and click the Search Button. Click the search buttondrop-down button to modify the Search Options.

Click the search button again to search for more matches of the same name.

Search Option Description

Match Whole WordOnly

Matches only the whole words that match the search textspecified in the Search Box. For example, search text Mar will notfind March.

Match Case Makes the search case sensitive. For example, search text MARwill not find Mar.

Member Names Search member names for the specified search text

Member Aliases Search member aliases for the specified search text

Search Direction Sets the search direction.

4.8.12 Running a Selection

A Selection can be run from the Selection Manager UI or a Command Line . To run aSelection from the Selection Manager:

· Open the Selection you wish to run by clicking on the respective Selection icon

127



· Click Run from the Selection Manager Toolbar. Click the Save button first ifthe Run button is grayed-out.

· Prior to running, SIS validates the Selection to ensure it will run appropriately.Once running, SIS displays dual progress bars for the process along with aCancel button to cancel the process, if desired



4.9 Using the Log Viewer

The purpose of the Log Viewer is to provide a list of SIS log records for viewing errors,warnings or information from SIS. SIS has a single logging point where all loginformation is directed to a table in the SIS database. The Log Viewer provides forfiltering and exporting the log view.

In addition to standard logging of SIS activity, SIS assigns a Process ID to all log recordsassociated with the running of a Selection. The Process ID is assigned to all logging forthe duration of the process run. This provides an easy filtering mechanism to track thehistory of a given process. This is discussed further in the following section entitled Filtering the View .

See Also:

· Information in the Log Viewer

· Filtering the View

· Viewing Individual Log Entries

· Exporting the View

4.9.1 Information in the Log Viewer

The Log Viewer contains the following log information:

Field Name Description

LogID Incremental log record identifier; value guarantees that each log recordis unique

Entry Date Date and time the log record was entered

124

123

124

125

126



Field Name Description

ProcessID Process ID reflecting a given Selection run. If the ProcessID is -1, thenthe log record is not associated with the running of a Selection. If,however, the Process ID is any other number, it reflects a uniqueprocess ID for a given Selection.

Type Type of log record - currently there are three types of log records:

· ERRORS: Reflects errors in the program that usually need attention

· WARNINGS: Typically reflects warnings from a business perspectiveand do not reflect a program failure

· INFORMATION: Reflect only information recorded by SIS that doesnot require any action or investigation

Entry Actual description of the log entry

Source Module and method where the log record was caught and recorded. Thisis helpful information for Star Analytics support when working withsupport requests.

Machine Server that generated the log entry. This does not have to be themachine on which SIS is installed. It could, for example, be a SatelliteServer .

User Operating system user performing operations resulting in the log entry

SelectionName

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

ProcessName

Name of the process, such as Essbase, that generated the log entry

4.9.2 Filtering the View

The SIS Log Viewer provides the capability to filter log records in the Log View to makethe log information more readable in determining the history of SIS activity. All of thefilter options as displayed in the top portion of the Log Viewer window as shown in thefollowing figure.

One of the first ways to filter the Log View is based on the Type. The Log Viewer toolbarcontains three push buttons to display or hide all of the log types such as Errors,Warnings and Information. As a result, any combination of log types can be displayed bytoggling these toolbar buttons. Each time any of these buttons are changed, the recordsdisplayed in the view are refreshed with the new filter options.

13



The remaining filter options requires Refresh on the toolbar to be clicked to reflect thefilter changes in the view. Each of these filter options are described in the followingtable:

Option Description

Filter on Last Filtering on the Date field based on the number of days from thecurrent day backwards. This option is mutually exclusive to theFilter on date range option.

Filter on DateRange

Filtering on the Date field where a date range is specified in thefrom and to date selection boxes. This option is mutually exclusiveto the Filter on last option.

Filter on Selection Filtering on Selection job runs. To enforce this filter, select thedesired Selection from the drop down box and click refresh. Thisoption displays all log records associated with process IDscorresponding to the selected Selection and can be combined withany other filter option.

Filter onProcessID

Filtering the log view based on a specific ProcessID. To enforce thisfilter, type the desired ProcessID in the ProcessID text box andclick Refresh. This option can be combined with any other filteroption.

4.9.3 Viewing Individual Log Entries

The following figure reflects a sample log records:

The Entry field tends to be too long to view from the list view itself. To view all thedetails of a specific log record, click on View Item. Or, simply double-click on the logrecord. Either method displays an expanded dialog form of the log record, as shownbelow.



4.9.4 Exporting the Log View

In addition to filtering the log records, the SIS Log Viewer also provides for exporting allor selected log records in the view to a text file. To export all records in the log view,click Export on the toolbar. Or you may select Export from the SIS menu.

This displays a Save File dialog to specify a file and path where the log records are to beexported. Once the file has been specified and Save is clicked, all of the records in theview is exported.

To export selected records in the log view, select the log record(s) to export, and thenright-click and select Export Selected Records to File. This displays a Save File dialog tospecify a file and path where the log records are to be exported. Once the file has beenspecified and Save is clicked, the selected records in the view is exported.



4.10 Using the SIS Command Line Interface

The SIS Command Line Interface (SISCMD) is a utility for running SIS Selections from acommand line. It supports running Selections from a command console (InteractiveMode) or from a batch file as part of an automation process (Batch Mode).

To run SISCMD in Interactive Mode select the 'SISCMD Utility' menu item from the 'StarAnalytics' Start Menu folder. Note: The very first time, you may have to select it twice toallow for the initialization to take place.

To run SISCMD in Batch Mode, open a command prompt window and type 'C:\Program

Files\Star Analytics\SIS\SISCMD.exe' followed by the SISCMD parameters, where '

C:\Program Files\Star Analytics' is the install directory or add the equivalent

command to a batch file and run it.

SISCMD returns the following return codes:

· -1: Indicates an error

· 0: Indicates that the process has terminated normally

See Also:

· SISCMD Interactive Mode

· SISCMD Batch Mode

· SISCMD Command File Syntax

4.10.1 SISCMD Interactive Mode

To run SISCMD in Interactive Mode select the 'SISCMD Utility' menu item from the 'StarAnalytics' Start Menu folder. Note: The very first time, you may have to select it twice toallow for the initialization to take place.

Type commands, one at a time, in the syntax shown below followed by a carriagereturn.

SISCMD in Interactive Mode supports the following commands:

Command Description

DELETE_SELECTION_ALL * Deletes all selections.

DELETE_SELECTION <selection ID |selection name> *

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

Example:

127

141

143



Command Description

The following example lists the selections, deletes a selection, and list the selectionsagain showing that a new connection has been deleted.

EXIT Exits SISCMD.

EXPORT_ALL <directory name> Exports all selections and connections to the <directory name> directory.

Example:

EXPORT_CONNECTION_ALL<directory name>

Exports all connections to the <directoryname> directory.

Example:



Command Description

EXPORT_CONNECTION <connectionID | connection name> < directoryname>

Exports the connection with the ID of <connection ID> or name of <connectionname> to the <directory name> directory.

Example:

Given the connections listed below

the following command exports the 'Comma HFM Connection' to 'C:\temp'

EXPORT_SELECTION_ALL <directoryname>

Exports all selections to the <directoryname> directory.

Example:

EXPORT_SELECTION <selection ID |selection name> < directory name>

Exports the selection with the ID of <selectionID> or name of <selection name> to the



Command Description

<directory name> directory.

Example:

Given the selections listed below

the following exports the selection 'HFM Selection' to the 'C:\temp' directory.

HELP Displays the on-line help.

IMPORT_CONNECTION_ALL<directory name> *

Imports all connections from the <directoryname> directory.

IMPORT_CONNECTION <connectionfile name> *

Imports a previously exported connectionfrom the <connection file name> name.

Example:

The following example lists the connections, imports a connection, and list theconnections again showing that a new connection has been added.



Command Description

IMPORT_SELECTION <selection filename> <source connection ID | sourceconnection name> <target connectionID | target connection name> *

Imports a previously exported selection fromthe <selection file name> name and assignsthe source and target connections to it.

Example:

The following example lists the selections, imports a selection, and lists theconnections again.



Command Description

LIST Displays a list of all selections.

Example:

LIST <selection ID> Displays a list of all members of the selectionwith the ID of <selection ID>.

Example:



Command Description

LIST <selection name> Displays a list of all members of the selectionwith the name of <selection name>.

Example:

LIST_CONNECTIONS Displays a list of all connections.

Example:



Command Description

RUN ALL Runs all selections.

Example:

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

Example:



Command Description

RUN ALL <selection ID1> <selection ID2> ... <selection IDn>

Runs all specified selections.

Example:



Command Description

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

Example:



Command Description

RUN <selection name> Runs the selection with the name of <selection name>.

Example:

RUN <selection ID> <command file name>

Runs the selection with the ID of <selectionID> with additional input or modificationcommands from the command file.

Example:

The following is an example of running a selection with commands from a commandfile. The command file is this case adds two member selections. For more examples ofcommand file commands, see SISCMD Command File Syntax .

Command File (MyCommands.txt):

UPDATE Market West ICHILDRENUPDATE Market South ICHILDREN

143



Command Description

RUN <selection name> <command file name>

Runs the selection with the name of <selection name> with additional input ormodification commands from the commandfile.

RUN <selection ID> <Dimension> <Member> <Function> [<Custom Name>]

Runs the selection with the ID of <selectionID>. If the <Dimension><Member> memberis selected in the selection its <Function> willbe updated. If the member is not selected itwill be added to the selection before it is run.Use the <Custom Name> to change the nameof the <Member> as it appears in the outputfrom the run.

<Function> is one of:

MEMBER, CHILDREN, ICHILDREN,DESCENDANTS, IDESCENDANTS,ANCESTORS, IANCESTORS, LEVMBRS orPARENT

Note:

Not all functions are valid for all members. Itis recommended that you use the StarIntegration Server UI to check which functionis valid for each member. Right-click on amember in the SIS UI outline to see all validfunctions for that member.

Examples:

Using the selection listed below

the following is an example of dynamically adding a member to an existing selection.



Command Description

The example below shows how to modify an existing member selection. In this case,the function of Market, East was modified from ICHILDREN to LEVMBRS.

RUN <selection name> <Dimension> <Member> <Function> [<Custom Name>]

Runs the selection with the name of <selection name>. If the <Dimension> <Member> member is selected in the SavedSelection its <Function> will be updated. Ifthe member is not selected it will be added tothe Selection before it is run. Use the <Custom Name> to change the name of the <Member> as it appears in the output from therun.


MEMBER, CHILDREN, ICHILDREN,



Command Description

DESCENDANTS, IDESCENDANTS,ANCESTORS, IANCESTORS, LEVMBRS orPARENT

Note:

Not all functions are valid for all members. Itis recommended that you use the StarIntegration Server UI to check which functionis valid for each member. Right-click on amember in the SIS UI outline to see all validfunctions for that member.

Examples:

See the 'RUN <selection ID> <Dimension> <Member> <Function> [<Custom Name>]' forexamples. Substitute the selection id '12' with'Type III Essbase Selection'.

UPDATE_SELECTION <selection ID |selection name> <selection filename> [<source connectionID |source connection name> <targetconnection ID | target connectionname>] *

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

Example:

Notes:

Parameter values like member names, selection names, command file names and customnames that contain spaces must be enclosed in double-quotes.

Commands marked with an asterisk (*) make permanent changes to your SISconfiguration.



4.10.2 SISCMD Batch Mode

To run SISCMD in Batch Mode, open a command prompt window and type 'C:\Program

Files\Star Analytics\SIS\SISCMD.exe' followed by the SISCMD parameters, where '

C:\Program Files\Star Analytics' is the install directory or add the equivalent

command to a batch file and run it.

See SISCMD Interactive Mode section for examples.

SISCMD in Batch Mode supports the following 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 <selection name>.

[RUN] <selection ID> <command file name>

Runs the selection with the ID of <selection ID> withadditional input or modification commands from acommand file.

[RUN] <selection name> <command file name>

Runs the selection with the name of <selection name>with additional input or modification commands from thecommand file.

[RUN] <selection ID> <Dimension> <Member> <Function> [<Custom Name>]

Runs the selection with the ID of <selection ID>. If the <Dimension><Member> member is selected in the SavedSelection its <Function> will be updated. If the memberis not selected it will be added to the Selection before itis run. Use the <Custom Name> to change the name ofthe <Member> as it appears in the output from the run.


MEMBER, CHILDREN, ICHILDREN, DESCENDANTS,IDESCENDANTS, ANCESTORS, IANCESTORS, LEVMBRS orPARENT

Note:

Not all functions are valid for all members. It isrecommended that you use the Star Integration ServerUI to check which function is valid for each member.Right-click on a member in the SIS UI outline to see allvalid functions for that member.

[RUN] <selection name> <Dimension> <Member> <Function> [<Custom Name>]

Runs the selection with the name of <selection name>. Ifthe <Dimension> <Member> member is selected in the Saved Selection its<Function> will be updated. If the member is notselected it will be added to the Selection before it is run.Use the <Custom Name> to change the name of the <Member> as it appears in the output from the run.

127





MEMBER, CHILDREN, ICHILDREN, DESCENDANTS,IDESCENDANTS, ANCESTORS, IANCESTORS, LEVMBRS orPARENT

Note:

Not all functions are valid for all members. It isrecommended that you use the Star Integration ServerUI to check which function is valid for each member.Right-click on a member in the SIS UI outline to see allvalid functions for that member.

[RUN] ALL Runs all Selections.

[RUN] ALL <Start ID> - <End ID>

Runs all Selections with IDs greater than or equal to <Start ID> and smaller than or equal to <End ID>.

[RUN] ALL <selection ID1> <selection ID2> ... <selection IDn>

Runs all specified Selections.

DELETE_SELECTION_ALL*

Deletes all selections.

DELETE_SELECTION <selection ID | selectionname> *

Deletes the selection with the ID of <selection ID> orname of <selection name>.

EXPORT_ALL <directoryname>

Exports all selections and connections to the <directoryname> directory.

EXPORT_CONNECTION_ALL <directory name>

Exports all connections to the <directory name>directory.

EXPORT_CONNECTION<connection ID |connection name> <directory name>

Exports the connection with the ID of <connection ID> orname of <connection name> to the <directory name>directory.

EXPORT_SELECTION_ALL <directory name>

Exports all selections to the <directory name> directory.

EXPORT_SELECTION <selection ID | selectionname> < directory name>

Exports the selection with the ID of <selection ID> orname of <selection name> to the <directory name>directory.

IMPORT_CONNECTION_ALL <directory name> *

Imports all connections from the <directory name>directory.

IMPORT_CONNECTION<connection file name> *

Imports a previously exported connection from the <connection file name> name.




IMPORT_SELECTION<selection file name><source connection ID |source connection name><target connection ID |target connection name> *

Imports a previously exported selection from the <selection file name> name and assigns the source andtarget connections to it.

UPDATE_SELECTION <selection ID | selectionname> <selection filename> [<source connectionID | sourceconnection name> <targetconnection ID | targetconnection name>] *

Updates an existing selection with settings from apreviously exported selection file and optionally assignsthe source and target connection to it. The selection willkeep its original source and target connections if nosource and target connections specified..

Notes:

Parameter values like member names, selection names, command file names and customnames that contain spaces must be enclosed in double-quotes.

Commands marked with an asterisk (*) make permanent changes to your SISconfiguration.

4.10.3 SISCMD Command File Syntax

The Command File is an text file with commands to SISCMD. Place each command on aseparate line in the file. Lines that begin with a ';' are considered comments and will beignored.

For a more in-depth description of each command please refer to the section SettingExtraction Options .

Command Syntax Description

CREATE_STAR_SCHEMA <ON | OFF>

Turns creation of the metadata and data tables on or off.

DATA_PRECISION <Precision> <Precision> Specifies the number of decimal places the

extracted data will be rounded to. Valid range is 0 - 15.

DELETE_ALL <Dimension>

Deletes all selected members from the <Dimension>

88




dimension from the Selection before it is run. The

command will be ignored if the <Dimension> doesn't

exist.

DELETE <Dimension> <Member>

Deletes the <Dimension> <Member> member from the

Selection before it is run. The command will be ignored if

either the <Dimension> or the <Member> doesn't exist.

DIMENSION_TABLE_LAYOUT <PARENT_CHILD |BALANCED | QLIKVIEW |MDM>

This option determines the format of the metadatatables.

EXTRACT_METADATA <ON | OFF>

Turns extraction of metadata on or off.

EXTRACT_PARENT_MEMBERS <ON | OFF>

When this parameter is set to ON, the EntityParent valuefor each Entity member is exported to the targetconnection. HFM Only.

EXTRACTION_TYPE<TYPE_I | TYPE_II |TYPE_III | TYPE_IV>

Sets the extraction type. Essbase / Planning Only.

FACT_TABLE_FORMAT<NARROW | WIDE>

This parameter sets the layout of the FACT table.

FACT_TABLE_NAME <FACT Table Name>

This parameter sets the name of the FACT table wheredata is extracted to.

LOAD_TYPE <REFRESH |APPEND | MERGE>

Specifies how data is written to the target connection.

MEMBER_VALUES<MEMBER_NAMES |MEMBER_ID>

This option determines the format of thedimension column values of the FACT table.

PREFIX <Prefix> Sets the Star Schema Prefix.

RECORD_COMMIT <Record Commit Number>

<Record Commit Number> Specifies the number ofextracted data records that will be held in memory beforethey are committed to the target connection.

SOURCE_CONNECTION <The source connection used by this Selection. The sourceconnection can be specified as the name of the




Source Connection Name |Source Connection ID> [<Source Connection UserName> <SourceConnection Password> [<RDBMS Connection UserName> <RDBMSConnection Password>]]

connection or the ID of the connection. The <SourceConnection Name> is the name shown in the ConnectionManager Connection 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 User Nameand Password of the connection. This only applies toPlanning connections.

User Names and Passwords will be ignored if a sourceconnection does not require them.

TARGET_CONNECTION <Target Connection Name |Target Connection ID> [<Target Connection UserName> <Target ConnectionPassword>]

The target connection used by this Selection. The targetconnection can be specified as the name of theconnection or the ID of the connection. The <TargetConnection Name> is the name shown in the ConnectionManager Connection List.

Specify <Target Connection User Name> and <TargetConnection Password> to modify the User Name andPassword of the connection.

User Names and Passwords will be ignored if a targetconnection does not require them.

UPDATE <Dimension> <Member> <Function> [<Custom Name>]

If the <Dimension><Member> member is selected in the

Saved Selection its <Function> will be updated. If the

member is not selected it will be added to the Selection

before it is run. Use the <Custom Name> to change the

name of the <Member> as it appears in the output from

the run.


MEMBER, CHILDREN, ICHILDREN, DESCENDANTS,

IDESCENDANTS, ANCESTORS, IANCESTORS, LEVMBRS or

PARENT

Note:

Not all functions are valid for all members. It is

recommended that you use the Star Integration Server

UI to check which function is valid for each member.




Right-click on a member in the SIS UI outline to see all

valid functions for that member.

USE_ALIAS <ON | OFF> When set to ON, member aliases will be extracted to thetarget connection FACT table rather than the membername. Essbase / Planning Only.

Note: Parameter values like member names, selection names, command file names andcustom names that contain spaces must be enclosed in double-quotes.

Example:

Running this selection as-is

will give the following result:



Running it with the command file listed below (comments not part of the command file)

will give the following result:



5 Appendix A - SIS Star Schema Definition

· Overview

· Parent/Child Format

· Generation Format

· Master Data Management Format

· Essbase Dimension Table

· HFM Accounts Dimension Table

· HFM Scenario Dimension Table

· HFM Year Dimension Table

· HFM Period Dimension Table

· HFM ICP Dimension Table

· HFM Custom1- 4 Dimension Table

· HFM View and Value Dimension Tables

· Essbase and HFM Narrow FACT Table

· Essbase and HFM Wide FACT Table

· Planning Account Annotations FACT Table

· Planning Cell Text FACT Table

· Planning Form Annotations FACT Table

· Planning Planning Unit FACT Table

· Planning Supporting Details FACT Table

· Audit Table

· Essbase Filters

· Essbase Users

· HFM Process Management FACT Table

5.1 Overview

This appendix contains a data dictionary of the key tables created by SIS for relationaltarget connections. The star schema created by SIS follows the typical format with asingle FACT table and multiple dimension tables. The format of these tables is setup tosupport Hyperion Essbase Integration Services (EIS) in the form of structure andmetadata content. EIS utilizes specific member attribute codes in dimension tables usedfor building Hyperion Essbase cubes. SIS provides for these EIS specific codes inHyperion Financial Management Selections configured in the SIS Database Config table.By default, this table already contains the attribute codes used by EIS to build Essbase

149

152

152

154

155

157

163

166

167

168

169

171

172

172

173

174

174

175

175

176

177

179

180

Appendix A - SIS Star Schema Definition 150


cubes.

When the Create Star Schema option is selected for Selections containing a relationaltarget connection, a table is created for each dimension in the Selection and one FACTtable called “FACT” to contain source connection data. A future release of SIS providesfor naming the FACT table on a per connection basis.

All tables created by SIS are created to be very generic in accommodating any type ofdata. As a result, the data types used are a standard varchar(255) for text and numericfor numbers. In addition, SIS creates neither indexes nor relationships between thetables. After the Star Schema has been created, modifications may be made to the tabledefinition with respect to data types, indexes and/or relationships. Care should be taken,however, if these table properties need to be changed such that the metadata or data tobe written to these tables by SIS are accommodating. The portion of the table structurethat should not be modified, however, is as follows:

· Table names should not be changed

· Field names created by SIS should not be changed

· Fields created by SIS should not be deleted

NOTE: Care should be taken when modifying tables created by SIS such thatrecords can be written to these tables by SIS do not fail.

Dimension tables created from Essbase and HFM source connections have slightlydifferent table structures under the Parent/Child hierarchy layout. There is no difference,however, between Essbase and HFM source connections using the Generations format(Translation Table). The table definitions for the standard Parent/Child format aredescribed first followed by the definition of the Generations format.

NOTE: All Target Connection Star Schemas must be located in their owndatabases. Star Analytics does not support commingling of Target ConnectionStar Schemas with other application database tables.

5.2 Star Schema Fundamentals

The dimensional star schema is a relational schema whereby there is a central FACT tableto hold numerical data and joined to the FACT table are dimension tables that hold thecorresponding metadata. Metadata is often defined as data about data such as hierarchalrelationships and consolidation attributes.



The Essbase Outline is a manifestation of a relational star schema in a multidimensionaldata storage system. Often times, a star schema is referred to as a ‘cube ‘despite beingstored in a relational database. The Essbase Outline is an excellent visual representationof a cube and the related hierarchies, attributes and calculations.

The following screenshot is of a typical FACT table. It should be noted that the columns ‘PRODUCT’, ‘MARKET’, ‘MEASURES’, ‘YEAR’ and ‘SCENARIO’ are joined to the metadatatables which are often referred to as the star schemas dimensional tables.

The following screenshot is of a typical metadata table (dimensional table). In thisexample, hierarchies are being stored in a parent and child format. Notice that in eachrecord, the child of member ‘Product’ is ‘100’ and the child of ‘100’ is ‘100-10’.

In the following example, the Essbase Outline shows clearly how it can be aligneddirectly to the parent and child relationships defined in a dimensional table. It should benoted that a dimensional star schema is not required to build an Essbase Outline, butsimplifies maintenance especially if used in conjunction with The Hyperion EssbaseIntegration Services (EIS).



In summary, the SIS is specifically designed to generate and maintain a dimensional starschema (data and metadata). Note that the output target of SIS can be an ASCII text fileand does not necessarily need to be a relational star schema.

5.3 Parent/Child Format

The Parent/Child Star Schema format entails the dimension tables having one record foreach member in the dimension. Each record specifies the member name, its relatedattribute and its immediate parent. As such, the hierarchy relationship is implicitlyrepresented recursively by the PARENT and CHILD fields. Since Essbase and HFM both donot allow duplicate member names, each record in a dimension table is unique based onthe CHILD field. It should be noted that both Essbase and HFM support alternatehierarchies using the “Shared Member” concept. In these cases, child members might beduplicated underneath a separate roll up structure with a storage attribute of “SHARED”.

5.4 Generation Format

SIS provides the capability to create the target connection’s Star Schema in a Generationformat where each record in the dimension table reflects a level zero member and itsancestors beginning from Generation One. The FACT table contains one column for eachdimension selected in the respective Selection just as in the Parent/Child format. Theonly difference is that the column name reflects the maximum Generation column in therespective dimension table.

SIS automatically balances ragged hierarchies that exist from either Essbase or HFM. Thebalancing is done by using the same member name in each of the Generation columnswhere a generation does not exist. For example, if the Accounts dimension has amaximum of five generations, the columns in the Accounts dimension table isGeneration1, Generation2, Generation3, Generation4 and Generation5. If the Profithierarchy in Accounts only goes to Generation2 with Sales and COGS as the onlydescendants of Profit, the records for the Profit hierarchy looks as follows:

Generation1 Generation2 Generation3 Generation4 Generation5

Accounts Profit Sales Sales Sales

Accounts Profit COGS COGS COGS



This essentially balances the hierarchy required by some relational Hyperion reportingtools such as Hyperion Intelligence. The following tables illustrate the Generation formatfor dimension and FACT tables.

Generation Format

Column Name Data Type Description

GENERATION1 varchar(255)/varchar2(255) GENERATION1 is replacedwith the name of generation1 reflected in the Selection’sTranslation table. The valuesconsists of the membername at that generation.

GENERATION2 varchar(255)/varchar2(255) GENERATION2 is replacedwith the name of generation2 reflected in the Selection’sTranslation table. The valuesconsists of the membername at that generation.

GENERATIONn varchar(255)/varchar2(255) GENERATIONn is replacedwith the name of thedimension’s highestgeneration number reflectedin the Selection’s Translationtable. The values consists ofthe member name at thatgeneration.

FACT Table


DIM1MAXGEN varchar(255)/varchar2(255) DIM1MAXGEN is replacedwith the name of the largestcorresponding dimensiongeneration reflected in theSelection’s Translation table.The values consists of themember name at thatgeneration.

DIM2MAXGEN varchar(255)/varchar2(255) DIM2MAXGEN is replacedwith the name of the largestcorresponding dimensiongeneration reflected in theSelection’s Translation table.The values consists of themember name at thatgeneration.

DIMnMAXGEN varchar(255)/varchar2(255) DIMnMAXGEN is replaced




with the name of the largestcorresponding dimensiongeneration reflected in theSelection’s Translation table.The values consists of themember name at thatgeneration.

DATA numeric(14,x)/number(14,x) Actual data value of thedimension memberintersection. The precision ofthis field (x) is based on theData Precision option of theSelection used to create thetable.

STATUS varchar(100)/varchar2(100) ONLY used in the HFM FACTtable and is used to displaythe HFM data intersectionstatus provided by HFM.

5.5 Master Data Management Format

Master Data Management format is a specific format of Essbase and HFM metadataextraction that satisfies the importation requirements of Hyperion Master DataManagement Server.

· Action: Add or ChangeProp

· MDM Version: based upon setting in Target Connection – i.e., “UAT”

· Hierarchy: App Name, DB name and dimension

· Node: Parent Member (if ADD) or Child Member (if CHANGEPROP)

· Property: Child Member (if ADD) or PropertyName (if CHANGEPROP) – Notethat PropertyName can really be any property established in MDM

· Value: 0 (if ADD) or relevant value based upon 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

47



ChangeProp,UAT,Sample Basic Market,East,Variance,N

ChangeProp,UAT,Sample Basic Market,East,TwoPassCalc,N

5.6 Essbase Dimension Table

The following describes the Essbase Dimension Table:

Column Name Data Type * Description

ID integer/int Primary key field

DIMNAME varchar(255)/varchar2(255)

Name of the respectivedimension

PARENT varchar(255)/varchar2(255)

Parent member name tothe current member

CHILD varchar(255)/varchar2(255)

Member name

ALIAS1 - ALIAS10 varchar(255)/varchar2(255)

Up to 10 alias names.ALIAS1 is typically fromthe Default Alias Table.ALIAS2 is typically froman alternate Alias Table.

CONSOLIDATION varchar(255)/varchar2(255)

Aggregationspecification with theoutline; possible valuesare:

· +

· -

· *

· /

· %

· ~

DATASTORE varchar(255)/varchar2(255)

Data storage type asstored within Essbase;possible values are:

· S (Stored)

· N (Never Share)

· O (Label Only)

· SHARED (Shared)

· V (Dynamic Calc)

· X (Dynamic Calcand Store)




TIMEBALANCE varchar(255)/varchar2(255)

Essbase time balancespecification as definedin the Essbase outline;possible values are:

· N (None)

· F (First)

· L (Last)

· A (Average)

SKIP varchar(255)/varchar2(255)

Essbase time balanceskip specification asdefined in the Essbaseoutline; possible valuesare:

· N (None)

· M (Skip Missing)

· Z (Skip Zeros)

· B (Skip Missingand Zeros)

VARIANCE varchar(255)/varchar2(255)

Essbase variancespecification as definedin the Essbase outline;possible values are:

· E (Expense)

· N (Non-Expense)

TWOPASSCALC varchar(255)/varchar2(255)

Essbase two-pass calcspecification as definedin the Essbase outline;possible values are:

· T (Two-Pass CalcMember)

· N (No Two-PassCalc)

UDA1 - UDAn varchar(255)/varchar2(255)

User Defined Attributes.1 - 64 columns. See Star Schema Options

ATTR_ASSOC1 - ATTR_ASSOC10 varchar(255)/varchar2(255)

Essbase attribute 1 to10

FORMULA varchar(255)/varchar2(255)

Essbase memberformula attached to the

93




current member

MBRCOMMENT varchar(255)/varchar2(255)

Essbase membercomment assigned tothe current member

CUSTOM_NAME varchar(255)/varchar2(255)

User-defined customname

GENERATION varchar(255)/varchar2(255)

Essbase membergeneration

LEVEL varchar(255)/varchar2(255)

Essbase member level

SOLVE_ORDER varchar(255)/varchar2(255)

Solve order

* SQL Server, DB2, Sybase, MySQL / Oracle

5.7 HFM Accounts Dimension Table

The following describes the HFM Accounts Dimension Table:



DIMENSION varchar(255)/varchar2(255) Name of the respectivedimension

PARENT varchar(255)/varchar2(255) Parent member name assignedto the current member

PARENTID int/number Parent member ID assigned tothe current member

CHILD varchar(255)/varchar2(255) Current member name

AGGREGATION varchar(5)/varchar2(5) Aggregation specificationsymbol for the currentmember; possible values are:

· +

· -

· ~ (No Aggregation)

CUSTOM_NAME varchar(255)/varchar2(255) User-defined custom name

DESCRIPTION varchar(8000)/varchar2(8000)

Current member description

UNIQUE_ALIAS varchar(255)/varchar2(255) Unique alias for the current




member

DATA_STORAGE varchar(255)/varchar2(255) Data storage type as storedwithin HFM; possible valuesare:

· SHARED

· NEVER SHARE

· STORE

ITEM_LEVEL varchar(255)/varchar2(255) Member level

ITEM_GENERATION varchar(255)/varchar2(255) Member generation

ACCOUNT_TYPE_1 varchar(255)/varchar2(255) HFM account typespecification; possible valuesare:

· ASSET

· BALANCE

· CURRENCYRATE

· DYNAMIC

· EXPENSE

· FLOW

· GROUPLABEL

· INCOME

· LIABILITY

· NONFINANCIAL

· SYSTEM

· TEXT

· REVENUE

ACCOUNT_TYPE varchar(255)/varchar2(255) Essbase equivalent HFMaccount type specification;possible values are:

· PL (Profit/Loss)

· BS (Balance Sheet)

· STAT (StatisticalAccount)

TIME_BALANCE varchar(255)/varchar2(255) HFM time balancespecification; possible values




are:

· TB LAST

· TB NONE

VARIANCE_REPORTING varchar(255)/varchar2(255) HFM variance reportingspecification; possible valuesare:

· NON-EXPENSE

· EXPENSE

ISCALCULATED varchar(255)/varchar2(255) 'True' if an account’s data iscalculated by HyperionFinancial Management. 'False' ifmanually entered

ISCONSOLIDATED varchar(255)/varchar2(255) 'True' if an account’s data isconsolidated to parent entities.Otherwise 'False'

ISICP varchar(255)/varchar2(255) 'Y' if the account is used ininter-company transactions. 'N'if not.

PLUGACCT varchar(255)/varchar2(255) The member ID of theaccount’s plug account

CUSTOM1TOPMEMBER varchar(255)/varchar2(255) First account type attributeassigned to the currentmember

CUSTOM2TOPMEMBER varchar(255)/varchar2(255) Second account type attributeassigned to the currentmember

CUSTOM3TOPMEMBER varchar(255)/varchar2(255) Third account type attributeassigned to the currentmember

CUSTOM4TOPMEMBER varchar(255)/varchar2(255) Fourth account type attributeassigned to the currentmember

NUMDECIMALPLACES varchar(255)/varchar2(255) The maximum number ofdigits to the right of thedecimal point that the accountsupports

USESLINEITEMS varchar(255)/varchar2(255) 'True' if the account allows lineitems. 'False' otherwise

ENABLECUSTOM1AGGR varchar(255)/varchar2(255) 'True' if the




EnableCustom1Aggr attributeis enabled, 'False' if it isdisabled

ENABLECUSTOM2AGGR varchar(255)/varchar2(255) 'True' if theEnableCustom2Aggr attributeis enabled, 'False' if it isdisabled



USERDEFINED1 varchar(255)/varchar2(255) The account’s UserDefined1attribute



XBRLTAGS varchar(255)/varchar2(255) The account’s XBRLTagsattribute

SECURITYCLASS varchar(255)/varchar2(255) The ID of the security classthat has been assigned to theaccount

ICPTOPMEMBER varchar(255)/varchar2(255) The member ID of theInter-company Partnerdimension member that hasbeenassigned as an Accountdimension member’sICPTopMember attribute

ENABLEDATAAUDIT varchar(255)/varchar2(255) True FalseNOTE: For HFM 3.5.1, thisattribute is not supported andis set to False

DEFAULTPARENT varchar(255)/varchar2(255) The name of the default parent

DEFAULTPARENTID int/number The ID of the default parent




5.8 HFM Entity Dimension Table

The following describes the HFM Entity Dimension Table:



DIMENSION varchar(255)/varchar2(255) Name of therespectivedimension

PARENT varchar(255)/varchar2(255) Parent membername assignedto the currentmember

PARENTID int/number Parent memberID assigned tothe currentmember

CHILD varchar(255)/varchar2(255) Current membername

AGGREGATION varchar(5)/varchar2(5) Aggregationspecificationsymbol for thecurrent member;possible valuesare:

· +

· -

· ~ (NoAggregation)

CUSTOM_NAME varchar(255)/varchar2(255) User-definedcustom name

DESCRIPTION varchar(8000)/varchar2(8000) Current memberdescription

UNIQUE_ALIAS varchar(255)/varchar2(255) Unique alias forthe currentmember

DATA_STORAGE varchar(255)/varchar2(255) Data storagetype as storedwithin HFM;possible valuesare:




· SHARED

· NEVERSHARE

· STORE


ITEM_GENERATION varchar(255)/varchar2(255) Membergeneration

DEFCURRENCY varchar(255)/varchar2(255) The member IDof the Valuedimensionmember thatrepresents theentity’s defaultcurrency

ALLOWADJS varchar(255)/varchar2(255) 'True' if theentity allowsjournal entries.'False' if not

ISICP varchar(255)/varchar2(255) 'Y' if the entity isused ininter-companytransactions. 'N'if not

ALLOWADJFROMCHILDREN varchar(255)/varchar2(255) 'True' if theentity allowsjournal postingsfrom its children.'False' if not

SECURITYCLASS varchar(255)/varchar2(255) The ID of thesecurity classthat has beenassigned to theentity

USERDEFINED1 varchar(255)/varchar2(255) The value thathas been definedfor the entity’sUserDefined1attribute

USERDEFINED2 varchar(255)/varchar2(255) The value thathas been definedfor the entity’sUserDefined2




attribute

USERDEFINED3 varchar(255)/varchar2(255) The value thathas been definedfor the entity’sUserDefined3attribute

HOLDINGCOMPANY varchar(255)/varchar2(255) The name of theHoldingCompany

HOLDINGCOMPANYID int/number The ID of theHoldingCompany

SECURITYASPARTNER varchar(255)/varchar2(255) The name of theSecurityAsPartner

SECURITYASPARTNERID int/number The ID of theSecurityAsPartner

ORGBYPERIODFILTERINGON varchar(255)/varchar2(255) 'True' if theentity hasorganization byperiod filteringenabled. 'False'if not

DEFAULTPARENT varchar(255)/varchar2(255) The name of thedefault parent

DEFAULTPARENTID int/number The ID of thedefault parent


5.9 HFM Scenario Dimension Table

The following describes the HFM Scenario Dimension Table:



DIMENSION varchar(255)/varchar2(255) Name of therespectivedimension

PARENT varchar(255)/varchar2(255) Parent membername assigned tothe currentmember




PARENTID int/number Parent member IDassigned to thecurrent member

CHILD varchar(255)/varchar2(255) Current membername

AGGREGATION varchar(5)/varchar2(5) Aggregationspecificationsymbol for thecurrent member;possible valuesare:

· +

· -

· ~ (NoAggregation)

CUSTOM_NAME varchar(255)/varchar2(255) User-definedcustom name

DESCRIPTION varchar(8000)/varchar2(8000) Current memberdescription

UNIQUE_ALIAS varchar(255)/varchar2(255) Unique alias forthe currentmember

DATA_STORAGE varchar(255)/varchar2(255) Data storage typeas stored withinHFM; possiblevalues are:

· SHARED

· NEVERSHARE

· STORE


ITEM_GENERATION varchar(255)/varchar2(255) Membergeneration

DEFAULTFREQ varchar(255)/varchar2(255) The ID number ofthe Scenariodimensionmember’s defaultfrequency

DEFAULTVIEW varchar(255)/varchar2(255) The number thatidentifies the




default view of theScenariodimensionmember

ZEROVIEWFORNONADJ varchar(255)/varchar2(255) The member ID ofthe Viewdimensionmember that hasbeen assigned astheZeroViewForNonadj attribute

ZEROVIEWFORADJ varchar(255)/varchar2(255) The member ID ofthe Viewdimensionmember that hasbeen assigned astheZeroViewForAdjattribute

CONSOLIDATEYTD varchar(255)/varchar2(255) 'True' if theScenariodimensionmember supportsyear-to-dateconsolidation.'False' if not

USERDEFINED1 varchar(255)/varchar2(255) The UserDefined1attribute



SUPPORTPROCESSMANAGEMENT varchar(255)/varchar2(255) 'True' if theprocessmanagementfeature is enabled.'False' if not

SECURITYCLASS varchar(255)/varchar2(255) The ID of theassigned securityclass

MAXIMUMREVIEWLEVEL varchar(255)/varchar2(255) The valueassigned to theMaximumReviewL




evel attribute

USESLINEITEMS varchar(255)/varchar2(255) 'True' if theScenariodimensionmember supportsline items. 'False'if not

ENABLEDATAAUDIT varchar(255)/varchar2(255) 'True' if data auditis enabled. 'False'if notNOTE: For HFM3.5.1, thisattribute is notsupported and isset to 'False'

DEFFREQFORICTRANS varchar(255)/varchar2(255) DefFreqForICTransattribute.NOTE: For HFM3.5.1, thisattribute is notsupported and isset to 0

DEFAULTPARENT varchar(255)/varchar2(255) The name of thedefault parent

DEFAULTPARENTID int/number The ID of thedefault parent


5.10 HFM Year Dimension Table

The following describes the HFM Year Dimension Table:



DIMENSION varchar(255)/varchar2(255) Name of the respective dimension

PARENT varchar(255)/varchar2(255) Parent member name assigned tothe current member

PARENTID int/number Parent member ID assigned to thecurrent member


AGGREGATION varchar(5)/varchar2(5) Aggregation specification symbol




for the current member; possiblevalues are:

· +

· -





UNIQUE_ALIAS varchar(255)/varchar2(255) Unique alias for the currentmember

DATA_STORAGE varchar(255)/varchar2(255) Data storage type as stored withinHFM; possible values are:

· SHARED

· NEVER SHARE

· STORE



YEARRANGE_FIRST varchar(255)/varchar2(255) The first year in the range of validyears

YEARRANGE_LAST varchar(255)/varchar2(255) The last year in the range of validyears


5.11 HFM Period Dimension Table

The following describes the HFM Period Dimension Table:










AGGREGATION varchar(5)/varchar2(5) Aggregation specification symbolfor the current member; possiblevalues are:

· +

· -







· SHARED

· NEVER SHARE

· STORE



BASEFREQUENCY int/number The ID of the application’s basefrequency

FREQUENCY varchar(255)/varchar2(255) The ordinal position of a periodwithin the application’s basefrequency


5.12 HFM ICP Dimension Table

The following describes the HFM ICP Dimension Table:











· +

· -







· SHARED

· NEVER SHARE

· STORE



SECURITYCLASS varchar(255)/varchar2(255) The ID of the security class thathas been assigned to theInter-company Partner


5.13 HFM Custom1- 4 Dimension Tables

The following describes the HFM Custom1 - 4 Dimension Tables:



DIMENSION varchar(255)/varchar2(255) Name of the respectivedimension

PARENT varchar(255)/varchar2(255) Parent member name assignedto the current member

PARENTID int/number Parent member ID assigned tothe current member





AGGREGATION varchar(5)/varchar2(5) Aggregation specificationsymbol for the currentmember; possible values are:

· +

· -






DATA_STORAGE varchar(255)/varchar2(255) Data storage type as storedwithin HFM; possible valuesare:

· SHARED

· NEVER SHARE

· STORE



ISCALCULATED varchar(255)/varchar2(255) 'True' if the Custom dimensionmember’s data is calculated byHyperion FinancialManagement. 'False' if it ismanually entered

SWITCHSIGNFORFLOW varchar(255)/varchar2(255) 'True' if the Custom dimensionmember’s SwitchSignForFlowattribute is enabled. 'False' ifnot

SWITCHTYPEFORFLOW varchar(255)/varchar2(255) 'True' if the Custom dimensionmember’s SwitchTypeForFlowattribute is enabled. 'False' ifnot

USERDEFINED1 varchar(255)/varchar2(255) The UserDefined1 attribute



SECURITYCLASS int/number the ID of the security class




DEFAULTPARENT varchar(255)/varchar2(255) The name of the default parent

DEFAULTPARENTID int/number The ID of the default parent


5.14 HFM View and Value Dimension Tables

The following describes the HFM View and Value Dimension Tables:








· +

· -







· SHARED

· NEVER SHARE

· STORE






5.15 Narrow Format FACT Table

The following describes the Essbase and HFM Narrow FACT Table layout.

ColumnName

Data Type * Description

DIMNAME1 - DIMNAMEn

varchar(255)/varchar2(255)

or

int/number

depending on the 'Fact TableMember Values' setting (see Star Schema Options )

DIMNAME1 - DIMNAMEn is the name ofthe columns 1 - n selected to beexported.

If 'Use Member Names' is selected, thecolumn values are member names thatcorrespond to the CHILD field of therespective dimension table.

If 'Use Member ID Reference' is selected,the column values are the IDs thatcorrespond to the ID field of therespective dimension table.

DATA numeric(14,x)/number(14,x) Contains the actual data value of thedimension member intersection. Theprecision of this field (x) is based on theData Precision option of the Selectionused to create the table.

STATUS varchar(100)/varchar2(100) ONLY used in the HFM FACT table and isused to display the HFM data intersectionstatus provided by HFM

AUDITID int/number When a data extraction is run, either inHFM or in Essbase, SIS adds or updatesthe AUDITID field in the FACT table. TheAUDITID references a record in the FACTaudit table. This table has the samename as the FACT table plus a suffix of _AUDIT.


Note: The ordering of the DIMNAME1 - DIMNAMEn columns is determined by the 'Sort'column value of the Column Selection.

5.16 Wide Format FACT Table

The following describes the Essbase HFM Wide FACT Table:


DIMNAME1 - DIMNAMEn

varchar(255)/varchar2(255) DIMNAME1 - DIMNAMEn are thenames of the columns 1 - n selected

89




to be exported. The column valuesare member names that correspondto the CHILD field of the respectivedimension table

WideMember1 - WideMembern

numeric(14,x)/number(14,x) WideMember1 - Widemembern arethe names of the 1 - n Widedimension member columns. Thecolumn values are the actual datavalues of the dimension memberintersection. The precision of thesefields (x) is based on the DataPrecision option of the Selection usedto create the table.

STATUS varchar(100)/varchar2(100) ONLY used in the HFM FACT table andis used to display the HFM dataintersection status provided by HFM.

AUDITID int/number When a data extraction is run, eitherin HFM or in Essbase, SIS adds orupdated a field in the FACT tabledcalled AUDITID, which in turnreferences a record in the FACTaudittable. This table has the same nameas the FACT table, but has a suffix of _AUDIT.


See Star Schema Options for more information on the Wide dimension and the WideFACT Format.


5.17 Planning Account Annotations FACT Table

The following describes the Planning Account Annotations FACT Table:


DATABASE varchar(80)/varchar2(80) Name of the planning database

SCENARIOS varchar(80)/varchar2(80) The Scenario dimension member

VERSIONS varchar(80)/varchar2(80) The Scenarion version

ENTITIES varchar(80)/varchar2(80) The Entity dimension member

ACCOUNTS varchar(80)/varchar2(80) The Account dimension member

89




DESCRIPTION varchar(2000)/varchar2(2000) The description for the account

AUDITID int/number The AUDITID references a record in theFACTaudit table. This table has thesame name as the FACT table, but hasa suffix of _AUDIT


5.18 Planning Cell Text FACT Table

The following describes the Cell Text FACT Table:



TEXT varchar(2000)/varchar2(2000)

Cell note contents

<dimensions> varchar(80)/varchar2(80) One field for each dimension with celltext

NOTE_ID int/number ID of the cell note

AUDITID int/number The AUDITID references a record inthe FACTaudit table. This table hasthe same name as the FACT table, buthas a suffix of _AUDIT


5.19 Planning Form Annotations FACT Table

The following describes the Planning Form Annotations FACT Table:

ColumnName



FORM varchar(80)/varchar2(80) Name of the form

FORM_ID int/number ID of the form

TITLE varchar(40)/varchar2(40) The form title

TEXT varchar(2000)/varchar2(2000) The contents of the annotation

ANNOT_SEQ int/number Annotation sequence identifier

CREATED datetime/date Creation time and date



ColumnName


AUTHOR varchar(80)/varchar2(80) The name of the author of theannotation

AUTHOR_ID int/number The ID of the author of the annotation

AUDITID int/number The AUDITID references a record in theFACTaudit table. This table has thesame name as the FACT table, but has asuffix of _AUDIT


5.20 Planning Planning Unit FACT Table

The following describes the Planning Unit FACT Table:


PLANNING_UNIT varchar(80)/varchar2(80) Name of planning unit

PLANNING_UNID_ID int/number ID of planning unit

TITLE varchar(40)/varchar2(40) Planning unit title


Planning unit contents

SCENARIO varchar(80)/varchar2(80) Planning unit Scenario member

VERSION varchar(80)/varchar2(80) Name of version

ENTITY varchar(80)/varchar2(80) Planning unit Entity member

ANNOT_SEQ int/number Planning unit annotationsequence number

CREATED datetime/date Creation time and date

AUTHOR varchar(80)/varchar2(80) Name of author

AUTHOR_ID int/number ID of author

AUDITID int/number The AUDITID references a recordin the FACTaudit table. This tablehas the same name as the FACTtable, but has a suffix of _AUDIT


5.21 Planning Supporting Details FACT Table

The following describes the Planning Supporting Details FACT Table:





DETAIL_DESCRIPTION varchar(255)/varchar2(1500)

Supporting detail label

OPERATOR char/char Operator associated with detail0=ignore, 1=add, 2=subtract,3=multiply, 4=divide

POSITION int/number Position order of the detail (0based)

GENERATION int/number Generation of the detail (0based)

VALUE float/float Detail value

<dimensions> varchar(80)/varchar2(80) One field for each dimensionwith supporting details

DETAIL_ID int/number Detail identifier

AUDITID int/number The AUDITID references arecord in the FACTaudit table.This table has the same nameas the FACT table, but has asuffix of _AUDIT


5.22 Audit Table

The AUDITID field in the FACT Table references the AUDITID field in the Audit Table. TheAudit Table always has the same name as the FACT table with the addition of the suffix"_AUDIT".


AUDITID int/number The ID of the entry

SavedSelectionID int/number Selection ID used when the dataextraction was run for the givenaudit record

SavedSelectionname varchar(500)/varchar2(500) Selection name used when thedata extraction was run for thegiven audit record

RecordDate DateTime/Date Date and time the data extractioncompleted and the audit recordwas written




SourceConnectionID int/number Connection ID for the sourceconnection used in the Selectionthat created the given auditrecord

SourceConnection varchar(500)/varchar2(500) Connection name for the sourceconnection used in the Selectionthat created the given auditrecord

LoadType varchar(25)/varchar2(25) Load type used for the dataextract based on the Selection;possible values are:

· Refresh

· Append

· Merge

SavedSelection image/blob Binary representation of theSelection state at the time theSelection was run. This can beviewed with the Star Analyticsobject viewer utility


5.23 Essbase Filters Tables

Hyperion Essbase filters for a given SIS Source Connection are exported to both theEssbase and Planning formats. These formats are supported in SIS to facilitate importingfilters into Hyperion Essbase or Hyperion Planning using the respective Hyperion utilities.Both formats extract one row of filter data for each unique combination of a filter rowassigned to an Essbase Application, Database and User.

The format for each of these tables is described below:

Essbase Filter Table


FilterName varchar(50)/varchar2(50) The name of the filter

EsbApplication varchar(50)/varchar2(50) Hyperion Essbase application namethat the filter belongs to

EsbDatabase varchar(50)/varchar2(50) Hyperion Essbase database name thatthe filter belongs to

UserName varchar(150)/varchar2(150) Hyperion Essbase user that the filter




is assigned to

EsbFilter varchar(4000)/varchar2(4000) Filter Member Specification as definedin Hyperion Essbase for the respectivefilter row

Access varchar(50)/varchar2(50) Access level granted to the EsbFilter;field has the following possiblevalues:

· Read

· Write

· None

· MetaRead

Planning Filter Table





UserName varchar(150)/varchar2(150) Hyperion Essbase user that the filteris assigned to

EsbMember varchar(100)/varchar2(100) Hyperion Essbase member that theAccess and EsbFunction is to beapplied for the current filter row

Access varchar(50)/varchar2(50) Access level granted to the EsbFilter;field has the following possible values:

· Read

· Write

· None

· MetaRead

EsbFunction varchar(50)/varchar2(50) Hyperion Essbase member expansionfunction to be applied to theEsbMember value for the current filterrow. For example, @CHILDREN is apossible value for this field whichindicates granting the level specified




in Access to the children of theEsbMember value.

Expanded Filter Table





UserName varchar(150)/varchar2(150) Hyperion Essbase user that the filteris assigned to

EsbMember varchar(100)/varchar2(100) Hyperion Essbase member that theAccess and EsbFunction is to beapplied for the current filter row

Access varchar(50)/varchar2(50) Access level granted to the EsbFilter;field has the following possible values:

· Read

· Write

· None

· MetaRead

EsbFunction varchar(50)/varchar2(50) Hyperion Essbase member expansionfunction to be applied to theEsbMember value for the current filterrow. For example, @CHILDREN is apossible value for this field whichindicates granting the level specifiedin Access to the children of theEsbMember value.


5.24 Essbase Users Tables

The Essbase Users metadata is extracted into two separate tables. The first table is asimple list of usernames, while the second table is a list of usernames and theirrespective user groups.



Essbase User Table


UserName varchar(70)/varchar2(70) Name of user

UserType varchar(15)/varchar2(15) 'ADMINISTRATOR' or 'USER'

Application varchar(70)/varchar2(70) Name of application the user hasaccess to

Database varchar(70)/varchar2(70) Name of database the user hasaccess to

Access varchar(10)/varchar2(10) The user's access rights to theapplication / database.

Either 'N' for NONE or a combination of ‘R’, ‘W’, ‘C’, ‘L’,and ‘D’ where ‘R’ = READ‘W’ = WRITE‘C’ = CALC‘L’ = DBLOAD‘D’ = DBDESIGN

Essbase User Group Table


UserGroup varchar(150)/varchar2(150) Name of a security group asspecified in the Hyperion Essbase

UserName varchar(150)/varchar2(150) Username as specified in theHyperion Essbase


5.25 HFM Process Management FACT Table

The following describes the HFM Process Management FACT Table:

ColumnName


Scenario varchar(255)/varchar2(255) The Scenario dimension member nameof the process unit

Year varchar(255)/varchar2(255) The Year dimension member name ofthe process unit

Period varchar(255)/varchar2(255) The Period dimension member name of



ColumnName


the process unit

Entity varchar(255)/varchar2(255) The Entity dimension member name ofthe process unit

EntityParent varchar(255)/varchar2(255) The Entity Parent dimension membername of the process unit

Value varchar(255)/varchar2(255) The Value dimension member name ofthe process unit

Time datetime/date The time of the process level change

User varchar(255)/varchar2(255) The name of the user that made theprocess level change

Action varchar(255)/varchar2(255) The action taken

State varchar(255)/varchar2(255) The process unit state after the processlevel change

Comments varchar(4000)/varchar2(24000)

Any comments added to the processlevel change

AUDITID int/number The AUDITID references a record in theFACTaudit table. This table has the samename as the FACT table, but has a suffixof _AUDIT


5.26 HFM Journal Items FACT Table

The following describes the HFM Journals Items FACT Table layout.


DIMNAME1 - DIMNAMEn


or

int/number

depending on the 'FactTable Member Values'setting (see Star Schema Options

)



If 'Use Member ID Reference' isselected, the column values are theIDs that correspond to the ID field ofthe respective dimension table.

JOURNAL_ID int/number The journal ID uniquely identifies the

89




journal.

JOURNAL_LABEL varchar(20)/varchar2(20) The name of the journal.

JOURNAL_DATA numeric(14,x)/number(14,x)

The data in the cell's journal entry. Theprecision of this field (x) is based onthe Data Precision option of theSelection used to create the table.

ENTRY_ID int/number The entry ID identifies the journal itemwithin the journal.

DEBIT_CREDIT varchar(1)/varchar2(1) 'C' if the journal item is a credit item.'D' if the journal item is a debit item.

DESCRIPTION varchar(50)/varchar2(50) The description of the journal item.

AUDITID int/number The AUDITID references a record in theFACT audit table. This table has thesame name as the FACT table plus asuffix of _AUDIT.



5.27 HFM Journals FACT Table

The following describes HFM Journals FACT Table layout.


JOURNAL_ID int/number The journal ID uniquely identifies thejournal.

JOURNAL_LABEL varchar(20)/varchar2(20) The name of the journal.

TYPE varchar(3)/varchar2(3) The type of journal.'ARL' if auto-reversal.'ARV' if auto-reversing.'REG' if regular.

STATUS varchar(1)/varchar2(1) The status of the journal.'A' if aproved.'P' if posted.'R' if rejected.'S' if submitted.'W' if working.

BALANCE_TYPE varchar(1)/varchar2(1) The balance type of the journal.'B' if balanced.'E' if balanced by entity.




'U' if unbalanced.

JOURNAL_GROUP

varchar(30)/varchar2(30) The name of the group the journal hasbeen assigned to (if any).


A description of the journal.

PERIOD ** The journal's period dimension.

VALUE ** The journal's value dimension.

SECURITYCLASS_ID

int/number The ID of the security class the journalbelongs to.

SINGLE_ENTITY ** The journal's entity dimension ifjournal is a single entity journal.

SINGLE_PARENT ** The journal's entity parent dimension ifjournal is a single entity journal.

CREATED_USER varchar(64)/varchar2(64) Name of user that created the journal.

POSTED_USER varchar(64)/varchar2(64) Name of user that posted the journal.

APPROVED_USER

varchar(64)/varchar2(64) Name of user that approved thejournal.

CREATED_DATE_TIME

DateTime/Date Date the journal was created

POSTED_DATE_TIME

DateTime/Date Date the journal was posted

APPROVED_DATE_TIME

DateTime/Date Date the journal was approved



** Data type depends on the 'Fact Table Member Values' setting (see Star SchemaOptions ) 'varchar(255)/varchar2(255)' if 'Use Member Names' is selected int/number if 'Use Member ID Reference' is selected

5.28 HFM Cell Line Item Details FACT Table

The following describes the HFM Cell Line Item Details FACT Table layout.

89




DIMNAME1 - DIMNAMEn


or

int/number

depending on the 'Fact TableMember Values' setting (see Star Schema Options)




DATA numeric(14,x)/number(14,x) Contains the line item data. Theprecision of this field (x) is based on theData Precision option of the Selectionused to create the table.

DESCRIPTION varchar(80)/varchar2(80) Contains the description of the line item.




5.29 HFM Cell Text FACT Table

The following describes the HFM Cell Text FACT Table layout.

ColumnName


DIMNAME1 - DIMNAMEn


or

int/number

depending on the 'Fact TableMember Values' setting (see Star Schema Options )




89

89



ColumnName



The cell text.

AUDITID int/number The AUDITID references a record in theFACT audit table. This table has the samename as the FACT table plus a suffix of _AUDIT.



5.30 HFM Cell History FACT Table

The following describes the HFM Cell History FACT Table layout.


DIMNAME1 - DIMNAMEn


or

int/number

depending on the 'FactTable Member Values'setting (see Star Schema Options

)



If 'Use Member ID Reference' isselected, the column values are theIDs that correspond to the ID field ofthe respective dimension table.

SERVER varchar(100)/varchar2(100) The name of the application server onwhich the data change was made.

USERNAME varchar(64)/varchar2(64) Name of the user who made thechange.

TIME_MODIFIED DateTime/Date Time and date the change was made.

ACTIVITY varchar(40)/varchar2(40) The change activity.ALLOCATECELL_LOGICCHART_LOGICCONSOLIDATIONCUSTOM_LOGICDATA_CLEARDATA_COPYDATA_ENTRY

89




DATA_EXTRACTDATA_EXTRACT_HALDATA_LOADDATA_RETRIEVALIDLEJOURNAL_ENTRYJOURNAL_POSTINGJOURNAL_RETRIEVALJOURNAL_TEMPLATE_ENTRYJOURNAL_UNPOSTINGLOGOFFLOGONLOGON_FAILUREMEMBER_LIST_EXTRACTMEMBER_LIST_LOADMEMBER_LIST_SCANMETADATA_EXTRACTMETADATA_LOADRULES_EXTRACTRULES_LOADRULES_SCANSECURITY_EXTRACTSECURITY_LOADSECURITY_SCANTRANSLATION

VALUE numeric(14,x)/number(14,x)

Contains the cell values that the datachanges resulted in. The precision ofthis field (x) is based on the DataPrecision option of the Selection usedto create the table.






6 Appendix B - Hyperion Planning & Drill Through Analytics

· Overview

· Star Integration Server - Bridge to Relational

· Essbase Integration Server - Bridge to Essbase

· EIS Drill Through Reporting with Template SQL

· Setting up Drill Through Reports

· Drill Through Analytics Workflow

6.1 Overview

Hyperion Planning is an extremely powerful planning environment to facilitate thecorporate budgeting process. Its capabilities are unparalleled with a robust zero clientweb front-end, true multidimensional calculation engine and sophisticated workflow tomanage the planning process.

Often times, Hyperion Planning functionality is extended to provide high level actualreporting so end-users can view actual results during the planning process. It is typicallya good practice to only load summarized data into Hyperion Planning and not burden thesystem with transactional detail that can result in less optimal performance. As such,end-users need a way to easily view voucher level transaction detail without leaving theHyperion environment that can often times be disruptive to end-user workflow.

In the diagram below the concept of Drill Through Analytics (DTA) is introduced wherebyall data, metadata and security is extracted from Hyperion Planning (Essbase) via theSIS and loaded into a standards based relational database in a star schema format. Oncethe data is staged, Hyperion Essbase Integration Services (EIS) can easily build areporting Hyperion Essbase cube. This solution has the primary benefit of separating thecalculation intensive Hyperion Planning environment from the reporting environment thatrequires consistent data and retrieval performance. Star Analytics has coined the termthe “U” method to describe this best practices approach.

The “U” method also has the benefit of providing an easy jump point to any data source(including text files) using ODBC (Open Database Connectivity) software drivers. Thisdocument describes this process in detail.

187

188

189

190

191

194

Appendix B - Hyperion Planning & Drill Through Analytics 188


6.2 Star Integration Server - Bridge to Relational

The SIS is an automated bridge that solves the difficulty of sharing HyperionPlanning,Hyperion Financial Management and Hyperion Essbase data with otherapplications and databases. SIS extends the use and availability of Hyperion BPM,necessary for real-time planning, uninterrupted applications availability and strategicreporting platforms.

In the DTA approach, SIS is a key part in facilitating this architecture. SIS has the abilityfor high-speed intelligent extraction of data, metadata and security from Hyperionsystems and placed into a standard relational star schema. Once in a star schema,Hyperion EIS can directly build a reporting Hyperion Essbase cube with zeromaintenance. This solution also has the benefit of separating the calculation intensiveHyperion Planning environment from the reporting environment that requires consistentdata and retrieval performance.

The following screenshot shows the SIS administrative interface to define source andtarget connections, SIS extraction profiles (data, metadata and security to be extracted),and system logs.



6.3 Essbase Integration Server - Bridge to Essbase

Essbase Integration Services (EIS) provides the critical link between the relational starschema and the Hyperion Essbase OLAP Server. EIS provides a way to transfer quicklythe relevant data in your relational star schema to an Essbase multidimensionaldatabase.

The following screenshot shows the EIS interface and a star schema with a FACT tableand dimensional tables.



6.4 EIS Drill-Through Reporting with Template SQL

A core component to setting up EIS drill through reports is to set up the Template SQL.To create a drill through report in Essbase Integration Services (EIS), the EIS userspecifies two categories of information.

1. The intersections that Essbase users is allowed to drill through from. This isthe ‘launch point’. It is defined by generation and /or level references ofdimensions in the Meta Outline. If a dimension is not described in the ‘OLAPIntersection Levels’, it implies all levels from that dimension is included.

2. Create/modify the SQL statement that is used to fetch the rows and columnsfrom an relational database. Rather than use the auto-generated SQL fromEIS, the ‘Template SQL’ feature is used which allows for customization of theSQL statement and its result set.

The power of the Template SQL feature is that the EIS user specifies the exact SQL queryneeded based upon what Essbase intersection was the launch point for the drill throughrequest.

For example, a Hyperion Essbase cube has summarized data for Sales by Region andProduct. The Essbase user wants to know sales detail by salesperson/product for a givenregion. A table or view in a relational database has transaction records with Salesperson,Region detail, Product code, sales amount, etc. A SQL drill through is set up to drillthrough on level 0 Region intersections. A simple template SQL to create the result setmight look like the following:

select ManagerName, Company, Product, Amount

from EIS_TRN.SALESDATA

where REGION = $$Region-VALUE$$



The variables between the ‘$$’ in the Template SQL receive values based upon the cellthat the drill through was launched from. In this case Entity E1100 was the launch pointfor the drill through report.

6.5 Setting up Drill-Through Reports

Follow these steps to setup a drill through report:

1. Start in the MetaOutline editor and then select Edit è Drill Through Reports.

2. ‘Add’ or ‘Edit’ a drill through report and select Use Template SQL.

3. Select the name of the drill through report to activate Template SQL….



4. Click Template SQL… to display either the generated SQL or the user definedTemplate SQL.



NOTE: Sample Drill Through Report Setup (SQL would need to be customizedbased on source).

5. Click User-Defined SQL and write the SQL in the lower pane. Itemsbetween the $$ are referenced from the cube in the form$$dimname-VALUE$$ where ‘dimname’ is the dimension name defined inthe MetaOutline and is case sensitive. The dimension name must be exactlyas in the MetaOutline as shown below:



6.6 Drill-Through Analytics Workflow

1. Select the report.

2. Select the User Point of View.

3. A sample Hyperion Report follows:



4. To use drill through, you can export from the browser to an Excel file using asimple, custom designed menu item under the File menu – ‘Drill ThroughDetail’.

5. The next step converts the web based report into a spreadsheet andautomatically opens Excel. The user selects a cell to drill through on and hitsthe hot key ‘Ctrl + D’ to initiate connection process into Essbase IntegrationServices.



6. Select a drill through report (to relational) or perform ad hoc analysis.

7. The results (records) from the relational database displays nn a new tab of aspreadsheet.

NOTE: Individual transaction amounts equal the cell that was drilled on.



7 Appendix C - Hyperion Essbase Integration Services

· Overview

· Basic Components

· High Level Workflow

· EIS Example

7.1 Overview

The documentation contained within this Appendix for Essbase Integration Services (EIS)is not exhaustive and simply shows a very simplistic and elementary build of an EISOLAP Model and EIS Meta Outline used together to build out an Essbase cube usingmetadata and data extracted via SIS.

This guide is not a replacement for a proper training class or the Hyperion EssbaseIntegration Services documentation. Star Analytics has professionals on staff to provideexpert EIS consulting as well as EIS training.

7.2 Basic Components

· OLAP Catalog

· OLAP Model

· Meta Outline

7.2.1 OLAP Catalog

An OLAP Catalog reflects:

· Tables that are proprietary to the EIS Server

· Stores all Metadata from dimensional tables and combines with Essbasespecific database information.

· Must be connected to an OLAP Catalog to use EIS

· Best practice to separate the OLAP Catalog from the star schema.

7.2.2 OLAP Model

An OLAP Model reflects the following:

· Reusable Representation of Relational Source

· Layer of abstraction to insulate Essbase from changes in the RDBMS

· One OLAP Model can ‘spawn’ more than one Meta Outline (Essbase cube)

· Best Practice to include all possible dimensions to guarantee referential

197

197

199

199

197

197

198

Appendix C - Hyperion Essbase Integration Services 198


integrity

· ‘Part 1’ interface in EIS

7.2.3 Meta Outline

A Meta Outline reflects the following:

· One-to-One to an Essbase cube

· All custom and real dimensions, hierarchies and custom and real members aredefined in the Meta Outline

· Hierarchies and member attributes defined in the Meta Outline directly buildEssbase dimensions

· Define Parent/Child hierarchies and custom dimensions and members

· Set cube properties and drill through reports

· Build and Load an Essbase database

· ‘Part 2’ interface in EIS



7.3 High Level Workflow

A typical workflow for building in EIS may consist of the following:

· Create/Define Relational source

· Set up ODBC (Open Database Connection) to Relational Data source

· Launch EIS Console Application

· Create OLAP Catalog to store EIS Metadata – data about the metadata

· Create OLAP Model – Graphical Star Schema representation of relational data

· Create Meta Outline – Tightly defined dimensional model of the star schemacreated in the OLAP Model

· Build Essbase Cube – 100% Automated and controlled by EIS

· Load Essbase Cube – 100% Automated and controlled by EIS

· Consolidate/Calculate Essbase Cube

· Review Results in a variety of front-end tools (Excel, Reports, Analyzer)

7.4 EIS Example

· Connect to EIS

· Build OLAP Model

· Set Properties of OLAP Model

· Create Meta Outline

· Set Dimension and Member Properties

· Create Attribute Dimensions

· Set Database Measures

· Building the Essbase Cube

7.4.1 Connect to EIS

1. Open the Essbase Integration Services Console.

2. Click Close to close the OLAP Metadata Catalog Setup.

3. Enter the following details on the Left side of the Login dialog box:

– Server: <EIS Server>

– OLAP Metadata Catalog: <EIS OLAP Metadata Catalog> (This is the ODBC Connection locally stored on your machine)

– OLAP Catalog UserID: <User ID for RDBMS housing the OLAPCatalog>

199

200

201

203

203

204

205

207



– OLAP Catalog Password: < Password for RDBMS housing the OLAPCatalog>

4. Create a connection to Essbase on the right side of the dialog box:

– Server: <Essbase Server>

– Essbase Username: <User ID for Essbase >

– Essbase Password: <Password for Essbase >

5. The Welcome dialog displays; select New Tab è OLAP Model è Open tocreate a new EIS OLAP Model.

6. Enter the following information when the Data Source dialog box displays:

– Server: <EIS Server>

– Data Source: <Data source housing the star schema> (This is the ODBC Connection locally stored on your machine)

– User Name <User ID for RDBMS housing the starschema>

– Password: <Password for RDBMS housing the starschema>

7. The OLAP Catalog interface displays with the following connection statuses:

7.4.2 Build OLAP Model

1. Expand the relational data source (in the example blow this is “EIS_TRN”) andselect the “FACT” table and drag to the right into the OLAP Model. EIS promptsif you would like to create a Time and Accounts dimensions. Click No to bothquestions.

2. Drag the “Measures” or “Accounts” dimension and then click Ok to add to thecurrent model.



3. In the interface toolbar, click Add Joins Mode ( ).

4. Create a line from the “Measures” or “Accounts” dimensional table to the“FACT” table.

5. A dialog box displays asking for the name of the dimension; default name isthe table name. Change the name to be title case, for example, change fromMEASURES to Measures.

6. The Edit Join Info dialog box displays next. This interface display all the fieldsfrom the <relational data source>.MEASURES table and the <relational datasource>.FACT table. On the MEASURES side, choose CHILD and on the FACTside choose MEASURES, click Add and then Close once the join has beenmade.

7. Repeat process for the other dimensions.

7.4.3 Set Properties of OLAP Model

1. In the OLAP Model, select a dimension such as “Product”. With Productselected, select Edit èProperties è Table to change table properties in theOLAP Model.



2. If applicable, choose the Columns tab and select ATTR_ASSOC_1 toATTR_ASSOC_3. Click Attributeto enable Attribute dimensions to be createdon the Product dimension.

3. Select the Physical Joins tab; this dialog box is used to set up a recursive jointo create parent/child hierarchies.

4. In the left Child column select the field CHILD and in the right Parent column



select the file PARENT. With both fields selected, click Add to add therecursive join.

5. Click Close to return to the OLAP Model

6. Repeat steps for the other dimensions.

7.4.4 Create Meta Outline

1. Drag individual members to create hierarchy (child only for Parent/Child).

2. Alternatively drag over any predefined hierarchies.

3. Add any custom dimensions or members.

7.4.5 Set Dimension and Member Properties

1. All dimension and member properties can be set.

2. SIS creates EIS Ready metadata. As such set up of all properties isplug-and-play by clicking From Database Column.



3. Interfaces are different depending if a dimension or Member is right-clicked.

7.4.6 Create Attribute Dimensions

· EIS Attribute Dimensions can be Text, Numeric, Boolean or Date however SIS canonly extract attribute dimensions of type Text

· One attribute from each Attribute Dimensions can be assigned to each sparsemember of the anchor dimension

· Once ‘Attribute Dimension’ is toggled on in the TABLE PROPERTIES in the OLAPModel, Attribute Dimensions automatically become available in the Meta Outline

· Attribute Dimensions from anchor dimension must be associated with a basemember and associated with a level such as Level 0



7.4.7 Set Database Measures

1. In the Meta Outline hierarchy, select the top member ‘Untitled’ or the MetaOutline name.

2. With this member selected, right-click and select Properties.

3. In the OLAP Meta Outline Properties dialog box, select the tab Database Measuresand then click ADD.

4. In the Measures Properties dialog box, double-click the DATA column. DATAshould now display in the Name field. Once this option has been set, it notifies theMeta Outline that the DATA column is where numeric values are stored.



7.4.8 Building the Essbase Cube

· The Essbase Outline is built directly from the Meta Outline

· Once the cube is built, the data from the FACT table can be loaded into the newlycreated structures

· Both of these are automatically performed by EIS

· Process can be scheduled or create automation script for batch processing

Building the Essbase Cube

1. Select Member and Data Load... from the Outline menu, make the followingsettings and be sure to change the Application name to your current OLAPModel Name.

2. Setup build options.



7. Set a time to run.



Index- A -Appendix A - Star Schema Data Dictionary 149

Appendix B - Hyperion Planning & Drill ThroughAnalytics 187


Audit Table 176

- B -Bridge to Essbase 189

Bridge to Relational 188

- C -Channel Registration for SIS Satellite Servers 24

Client-side Channel Registration 24

Server-side Channel Registration and RemoteObject Leases 24

Command Line 127

Configuring Star Integration Server 19

Connection ID 49

Connection Manager 46

Connection Type Parameters 59

Creating a Connection to Source and Target Systems 47

Creating Saved Selections 82

- D -Data Extraction Auditing 14

Data Extraction Options 96

Data Value Field Length in Star Schema Fact Table 26

Delete a Connection 54

Deleting a Saved Selection 84

Drill Through Analytics 187

Drill-Through Analytics Workflow 194

Drill-Through Reports 191

- E -Edit a Saved Connection 52

EIS Drill-Through Reporting 190

EIS Example 199

Build OLAP Model 200

Building the Essbase Cube 207

Connect to EIS 199

Create Attribute Dimensions 204

Create Meta Outline 203

Set Database Measures 205

Set Dimension and Member Properties 203

Set Properties of OLAP Model 201

EIS High Level Workflow 199

Enable Connection for Satellite Server 49

Essbase and HFM Narrow Fact Table 172

Essbase API Configuration 25

Essbase Connection Summary Table 60, 61, 81

Essbase Dimension Table 155

Essbase Filters 177

Essbase Integration Server - Bridge to Essbase 189

Essbase Users 179

Export a Connection 55

Exporting Saved Selections 87

Extended Connection String Parameters for the SISDB 26

- F -failed connection 50

- G -Generation Format 152

- H -HFM Accounts Dimension Table 157

HFM Connection Summary Table 65

HFM Custom1- 4 Dimension Table 169

HFM Entity Dimension Table 161

HFM ICP Dimension Table 168

HFM Period Dimension Table 167

HFM Scenario Dimension Table 163

HFM Star Schema Table Name Mapping 25

Index 210


HFM View and Value Dimension Tables 171

HFM Wide Fact Table 172

HFM Year Dimension Table 166

Hyperion Essbase Calculation Engine 8

Hyperion Essbase Extraction 7

Hyperion Essbase Metadata Extraction 11

Optimized Essbase Data Extraction 8

Hyperion Essbase Integration Services 197

Hyperion Essbase Report Script Engine 8

Hyperion Essbase Security Extraction 11

Hyperion Financial Management Extraction 12

HFM Metadata Extraction 13

Optimized HFM Data Extraction 12

Hyperion Planning 187

Hyperion PlanningExtraction 11

- I -Import a Connection 56

Importing Saved Selections 86

Intelligent Extraction 8

- L -Launching the SIS Manager 17

Load Balancing with Satellite Servers 13

Log Entries - Viewing 125

Log Viewer 123

Log Viewer - Exporting the View 126

Log Viewer Filter Options 124

Log Viewer Information 123

- M -Meta Outline 198

Metadata Extraction Options 94

- O -OLAP Catalog 197

OLAP Model 197

options 207

Oracle Connection Summary Table 74

- P -Parent/Child Format 152

Planning Account Annotations Fact Table 173

Planning Cell Text Fact Table 174

Planning Form Annotations Fact Table 174

Planning Planning Unit Fact Table 175

Planning Supporting Detail Fact Table 175

Planning+ 104

- R -Running a Saved Selection from the Command Line 127

Running a Selection 121

- S -Searching for Outline Members 121

Selection Manager 82

Selection_Manager_Options 19

Setting Hyperion Essbase Extractor Options 44

Setting_Config_File_Options 22

Setting_Extraction_Options 88

SIS Database Configuration File Location 26

SIS_Database_Configuration 31

Spin Dimension 109

Splash Screen Display Time 25

SQL Server Trusted Connection Summary Table 71

SQLServer-SQLLogin Summary Table 72

Star Analytics’ STAR Integration Server Version 2.1.0 3

Star Integration Server Components 7

Star Integration Server Deployment Architecture 5

Star Integration Server Deployment Topology 4

Star Integration Server Features 7

STAR Integration Server Usage 16

Star Schema Data Dictionary 149

Star Schema Fundamentals 150

- T -

Target_Database_Table_and_Column_Name_Mapping 22



Test a Connection 50

Text Connection Summary Table 79

- U -UDA 93

Use Auto connection Paramaeter Update 26

Using the Connection Manager 46

Using the Log Viewer 123

Using the Selection Manager 82

- V -View Uses 57

sis 2.8.3 admin guide

Documents