IBM Cognos Command Center Plug-in for Oracle Essbase...

IBM Cognos Command CenterPlug-in for Oracle EssbaseVersion 10.2.0

User Guide

��

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

Product Information

This document applies to IBM Cognos Command Center 10.2.0 and may also apply to subsequent releases.

Licensed Materials - Property of IBM

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

Contents

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

Chapter 1. Oracle Essbase plug-in overview . . . . . . . . . . . . . . . . . . . . 1

Chapter 2. Installing the Oracle Essbase plug-in . . . . . . . . . . . . . . . . . . 3

Chapter 3. Oracle Essbase plug-in configuration . . . . . . . . . . . . . . . . . . 5

Chapter 4. Oracle Essbase plug-in task reference . . . . . . . . . . . . . . . . . . 7Specifying the setting for the Export Data (J) task. . . . . . . . . . . . . . . . . . . . . . . 17

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

© Copyright IBM Corp. 2008, 2013 iii

iv IBM Cognos Command Center Plug-in for Oracle Essbase Version 10.2.0: User Guide

Introduction

The guide provides information that is intended for users and administrators ofIBM® Cognos® Command Center®.

Audience

The guide assumes that the reader is knowledgeable about Cognos CommandCenter concepts and general use of the product. For more information, see the IBMCognos Command Center Administration Guide.

Finding information

To find IBM Cognos product documentation on the web, including all translateddocumentation, access the IBM Cognos Command Center Information Center(http://pic.dhe.ibm.com/infocenter/ccc/v10r2m0/index.jsp). Release notes arepublished directly to Information Centers, and include links to the latest technotesand APARs.

You can also access PDF versions of the product documentation from the productdisks or from the IBM Cognos Command Center documentation web page(http://www.ibm.com/support/docview.wss?uid=swg27039519).

Accessibility features

This product does not currently support accessibility features that help users witha physical disability, such as restricted mobility or limited vision, to use thisproduct.

Forward-looking statements

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

© Copyright IBM Corp. 2008, 2013 v

http://pic.dhe.ibm.com/infocenter/ccc/v10r2m0/index.jsphttp://www.ibm.com/support/docview.wss?uid=swg27039519

vi IBM Cognos Command Center Plug-in for Oracle Essbase Version 10.2.0: User Guide

Chapter 1. Oracle Essbase plug-in overview

The Oracle Essbase plug-in provides a task type for automating commonoperations that target Oracle Hyperion Essbase from within IBM CognosCommand Center processes.

Compatibility

The Oracle Essbase plug-in is compatible with the following IBM CognosCommand Center components:

IBM Cognos Command Center Client10.1 or higher.

IBM Cognos Command Center Server10.1 or higher.

IBM Cognos Command Center Agent10.1 or higher on UNIX and the Microsoft Windows operating system.

On UNIX, a Java™ 1.6 environment must be available.

The plug-in requires Microsoft .NET Framework 3.5 or higher on Windows agenthosts.

The plug-in requires a Java environment on UNIX agent hosts. For moreinformation, see the IBM Cognos Command Center Agent for UNIX Installation Guide.

© Copyright IBM Corp. 2008, 2013 1

2 IBM Cognos Command Center Plug-in for Oracle Essbase Version 10.2.0: User Guide

Chapter 2. Installing the Oracle Essbase plug-in

You can install the Oracle Essbase plug-in from the menu of the IBM CognosCommand Center client.

Procedure1. Click Tools > Manage Plugin Tasks.2. In the Manage Plugin Tasks dialog, select the Oracle Essbase Plugin.x.x.zip

file in the INSTALLDIR\Plugins directory.3. Click Load file. After the plug-in is installed, the Automation Task > Oracle >

Essbase task and related tasks are available on the Add Task menu in theProcess Editor window.


Chapter 3. Oracle Essbase plug-in configuration

An Oracle Essbase computing resource must be configured to use the OracleEssbase plug-in. This resource type represents an Oracle Essbase server.

The following table shows the arguments for the configuration of the OracleEssbase computing resource.

Table 1. Configuration of the Oracle Essbase computing resource

Argument Description

Agent The agent that runs all tasks that are related to this resource.

Homedirectory

The directory to use when processing tasks on this resource.

Essbase ServerName

The Essbase server name.

Essbase UserName

The Essbase user name that runs tasks.

EssbasePassword

The password of the Essbase user.

Essbase ServerPath

The Essbase server path to the BIN directory.

Essbase JavaAPI Folder

The location of the Essbase Java API jar files. The plug-in expects to findess_es_server.jar and ess_japi.jar in this folder.

This argument is only required when you use the Export Data (J) task.

OracleDiagnosticLogging(ODL) Folder

Path of the Oracle Diagnostic Logging (ODL) folder. The plug-in looks forojdl.jar in this folder.

This argument is only required when you use the Export Data (J) task thattargets Essbase 11.

Attention: The plug-in uses the Essbase MaxL and ESSCMD command lineinterfaces. In order for the Task Pack to work properly, the user account that runsthe IBM Cognos Command Server agent on an Essbase server must be able to runMaxL and ESSCMD. To achieve this, you can include the local Windows account inthe Hyperion User group. If the agent does not use a valid Essbase user account,you might see the following error message when you try to run a task:

Error initializing localization module

If you receive this error, verify that the user account that is running the IBMCognos Command Center agent on an Essbase server has access to the Essbaseserver computer, and also can log on through the MaxL command line interface.

If these conditions are not satisfied, then modify your environment to start the IBMCognos Command Center agent with a user account that has access to the Essbasecommand line interfaces.


Chapter 4. Oracle Essbase plug-in task reference

The Essbase tasks have arguments that you can specify.

Copy app

The Copy App task copies a specified Essbase application to a new one.

The following table shows the task arguments for the Copy App task.

Table 2. Task arguments for the Copy App task


SourceApplication

The source application.

DestinationApplication

The destination application.

Copy Db

The Copy Db task copies a specified Essbase database to a new one.

The following table shows the task arguments for the Copy Db task.

Table 3. Task arguments for the Copy Db task


SourceApplication

The source application.

SourceDatabase

The source database from the source application.

DestinationApplication

The destination application.

DestinationDatabase

The destination database under the destination application.

Create variable

The Create Variable task creates a new Essbase substitution variable and sets avalue.

The following table shows the task arguments for the Create Variable task.

Table 4. Task arguments for the Create Variable task


ApplicationName

The application name.

DatabaseName

The database name.

VariableName

The variable name to create.


Table 4. Task arguments for the Create Variable task (continued)


Value The value to which the variable name is set.

Data load text file

The Data Load Text File task runs a data load of a specified text file to an Essbasedatabase.

The following table shows the task arguments for the Data Load Text File task.

Table 5. Task arguments for the Data Load Text File task


ApplicationName


DatabaseName

The database name.

Data FileName

The name of the text data file that is on the Essbase server. A file path canbe defined, for example c:\Files\Data.txt. If only a file name is specified,then the file path is set as the home directory of the Oracle Essbasecomputing resource.

Data load with rules

The Data Load with Rules task runs a data load of a specified file and data loadrule to an Essbase database. This task does not provide the option of specifying anerror log, so any load errors cause the task to fail in IBM Cognos CommandCenter.

The following table shows the task arguments for the Data Load with Rules task.

Table 6. Task arguments for the Data Load with Rules task


ApplicationName


DatabaseName

The database name.

Data FileName


Rules File The name of the Essbase rules file that is on the Essbase server. A file pathcan be defined, for example c:\Files\Act.Rul. If only a file name isspecified, then the file path is set as the home directory of the OracleEssbase computing resource.


Data load with rules log

The Data Load with Rules Log task runs a data load of a specified file and dataload rule to an Essbase database with error logging. If a data load error occurs,then the task returns a zero return code to IBM Cognos Command Center, with theerrors captured in the task output.

The following table shows the task arguments for the Data Load with Rules Logtask.

Table 7. Task arguments for the Data Load with Rules Log task


ApplicationName


DatabaseName

The database name.

Data FileName


Rules File The name of the Essbase rules file that is on the Essbase server. A file pathcan be defined, for example c:\Files\Act.Rul. If only a file name isspecified, then the file path is set as the home directory of the OracleEssbase computing resource.

Log FileName

The name of the Essbase output error log. A file path can be defined, forexample c:\Files\Data.Err. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Delete App

The Delete App task deletes an Essbase application.

The following table shows the task argument for the Delete App task.

Table 8. Task argument for the Delete App task


ApplicationName

The name of the application to delete.

Delete Db

The Delete Db task deletes an Essbase database.

The following table shows the task arguments for the Delete Db task.

Table 9. Task arguments for the Delete Db task


ApplicationName

The name of the application.

DatabaseName

The name of the database to delete.

Chapter 4. Oracle Essbase plug-in task reference 9

Delete variable

The Delete Variable task deletes a substitution variable.

The following table shows the task arguments for the Delete Variable task.

Table 10. Task arguments for the Delete Variable task


ApplicationName


DatabaseName

The name of the database.

VariableName

The name of the variable to delete.

Display lock

The Display Lock task displays block lock information for the Essbase applicationor database.

The following table shows the task arguments for the Display Lock task.

Table 11. Task arguments for the Display Lock task


ApplicationName


DatabaseName


Display Session

The Display Session task displays active login session information for the Essbaseapplication or database.

The following table shows the task arguments for the Display Session task.

Table 12. Task arguments for the Display Session task


ApplicationName


DatabaseName


Drop lock

The Drop Lock task removes any data block locks from Essbase for the Essbaseapplication or database.

The following table shows the task arguments for the Drop Lock task.


Table 13. Task arguments for the Drop Lock task


ApplicationName


DatabaseName


Export data

The Export Data task exports data from a specified database.

The following table shows the task arguments for the Export Data task.

Table 14. Task arguments for the Export Data task


ApplicationName


DatabaseName


Path OutputFile Name

The name of the export file to be created. A file path can be defined, forexample c:\Files\Dump.txt. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Export Data (J)

The Export Data (J) task exports data from a specified database.

The following table shows the task arguments for the Export Data (J) task.

Table 15. Task arguments for the Export Data (J) task


ApplicationName


DatabaseName


Member ListFile

An optional file that contains a list of members to extract.

The purpose of the member list file is to limit the output of the extractionto a subset of members. The format of the member list file is lines ofmember names, which are separated by theEssbaseMemberFileColumnSeparator (in the Essbase.properties file). Itdefaults to a comma. If a member name has a space or theEssbaseMemberFileColumnSeparator in it, it should be enclosed in doublequotation marks. You can enclose all names in double quotation marks, butit is not necessary. You can have as many lines with member names as youlike. For example, here is a two-line member list file:

100-10, "Sales", "Jan", Florida, "New York"

"West", 200, "Ratios"

Suppress Specifies whether certain values are suppressed from the output.


Table 15. Task arguments for the Export Data (J) task (continued)


Data Level Specifies the level of data to be extracted.

Attention: Essbase aggregate storage (ASO) cubes support only level 0.

Precision Specifies the number of decimal places for the output.

Output File The output file name. A file path can be defined, for examplec:\Files\JDump.txt. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Attention: This task must be run on an agent that is installed directly on theEssbase server. For more information, see “Specifying the setting for the ExportData (J) task” on page 17.

Get DB Info

The Get DB Info task displays DB information for the specified Essbase database.

The following table shows the task arguments for the Get DB Info task.

Table 16. Task arguments for the Get DB Info task


ApplicationName


DatabaseName


Grant access

The Grant Access task grants the security access level to the specified Essbasedatabase to a user or group.

The following table shows the task arguments for the Grant Access task.

Table 17. Task arguments for the Grant Access task


Access Defines the access control level: No Access, Read & Write, or Read Only.

ApplicationName


DatabaseName


User/GroupName

The user or group to which the access is assigned.

Grant execute

The Grant Execute task grants the security access level to the specified calc scriptto a user or group.

The following table shows the task arguments for the Grant Execute task.


Table 18. Task arguments for the Grant Execute task


ApplicationName


DatabaseName


Calc Script The Calc Script name.

User/GroupName

The user or group to which the access is assigned.

List variables

The List Variables task displays the substitution variables for the specified Essbaseapplication or database.

The following table shows the task arguments for the List Variables task.

Table 19. Task arguments for the List Variables task


ApplicationName


DatabaseName


Login switch

The Login Switch task enables or disables connections to a specified Essbaseapplication.

The following table shows the task arguments for the Login Switch task.

Table 20. Task arguments for the Login Switch task


Switch Specified whether to enable or disable connections.

ApplicationName


Metadata load

The Metadata Load task loads dimensions from a specified source to an Essbasedatabase.

The following table shows the task arguments for the Metadata Load task.

Table 21. Task arguments for the Metadata Load task


ApplicationName


DatabaseName



Table 21. Task arguments for the Metadata Load task (continued)


Data FileName

The data file name. A file path can be defined, for examplec:\Files\Product.txt. If only a file name is specified, then the file path isset as the home directory of the Oracle Essbase computing resource.

Rules FileName

The rules file name. A file path can be defined, for examplec:\Files\ProdBuild.rul. If only a file name is specified, then the file pathis set as the home directory of the Oracle Essbase computing resource.

Login FileName

The name of the Essbase output error log. A file path can be defined, forexample c:\Files\Data.Err. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Reset DB

The Reset DB task clears all data and linked reporting objects from a specifiedEssbase database.

The following table shows the task arguments for the Reset DB task.

Table 22. Task arguments for the Reset DB task


ApplicationName


DatabaseName


Run calc file

The Run Calc File task runs a calc script from a specified path on the Essbaseserver.

The following table shows the task arguments for the Run Calc File task.

Table 23. Task arguments for the Run Calc File task


ApplicationName


DatabaseName


Calc Script The calc script name. A file path can be defined, for examplec:\Files\Cal.csc. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Run calc script

The Run Calc Script task runs a calc script from the App/Db directory on theEssbase server.

The following table shows the task arguments for the Run Calc Script task.


Table 24. Task arguments for the Run Calc Script task


ApplicationName


DatabaseName


Calc Script The calc script name.

Run calc string

The Run Calc String task runs a calculation string.

The following table shows the task arguments for the Run Calc String task.

Table 25. Task arguments for the Run Calc String task


ApplicationName


DatabaseName


Calc String The Essbase calc string, for example: CALC ALL;

Run default calc

The Run Default Calc task runs the default calc against a specified Essbasedatabase.

The following table shows the task arguments for the Run Default Calc task.

Table 26. Task arguments for the Run Default Calc task


ApplicationName


DatabaseName


Run report script

The Run Report Script task runs a specified report script from a specified path onthe Essbase Server and outputs the results to a specified text file.

The following table shows the task arguments for the Run Report Script task.

Table 27. Task arguments for the Run Report Script task


ApplicationName


DatabaseName



Table 27. Task arguments for the Run Report Script task (continued)


Report Script The report script name. A file path can be defined, for examplec:\Files\Top.RPT. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Output FileName

The name of the output file. A file path can be defined, for examplec:\Files\Top.TXT. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Set default calc

The Set Default Calc task sets a calculation string as the default calc for adatabase.

The following table shows the task arguments for the Set Default Calc task.

Table 28. Task arguments for the Set Default Calc task


ApplicationName


DatabaseName


Calc String The Essbase calc string, for example: CALC ALL;

Start/Stop app

The Start/Stop App task starts a specified Essbase application.

The following table shows the task arguments for the Start/Stop App task.

Table 29. Task arguments for the Start/Stop App task


Start/Stop Specifies whether to start or stop the specified

ApplicationName


Update variable

The Update Variable task updates the value of a specified substitution variable.

The following table shows the task arguments for the Update Variable task.

Table 30. Task arguments for the Update Variable task


ApplicationName


DatabaseName


VariableName

The variable name.


Table 30. Task arguments for the Update Variable task (continued)


Value The value to which the variable is set.

Specifying the setting for the Export Data (J) taskThe Export Data (J) task must be run on an agent that is installed directly on theEssbase server. When you run an Essbase server on a Windows computer, youmust ensure that the following is set for the task to properly run.

Procedure1. Open regedit.2. Go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\

Parameters.3. If MaxUserPort is present, change its value to 65534 (decimal). If it is not, add a

DWORD value with the name MaxUserPort and the value 65534 (decimal).4. If TcpTimedWaitDelay is present, change its value to 30 (decimal). If it is not,

add a DWORD value with the name TcpTimedWaitDelay and the value 30(decimal).

5. Restart the computer.


Notices

This information was developed for products and services offered worldwide.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service. This document maydescribe products, services, or features that are not included in the Program orlicense entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.


IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Software GroupAttention: Licensing3755 Riverside DrOttawa, ON K1V 1B7Canada

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.


Trademarks

IBM, the IBM logo and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “ Copyright andtrademark information ” at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of

Microsoft Corporation in the United States, other countries, or both.v UNIX is a registered trademark of The Open Group in the United States and

other countries.v Java and all Java-based trademarks and logos are trademarks or registered

trademarks of Oracle and/or its affiliates.

Notices 21

http://www.ibm.com/legal/copytrade.shtmlhttp://www.ibm.com/legal/copytrade.shtml

ContentsIntroductionChapter 1. Oracle Essbase plug-in overviewChapter 2. Installing the Oracle Essbase plug-inChapter 3. Oracle Essbase plug-in configurationChapter 4. Oracle Essbase plug-in task referenceSpecifying the setting for the Export Data (J) task

Notices

Date post:	02-Feb-2021
Category:	Documents
Upload:	others
View:	6 times
Download:	0 times

IBM Cognos Command Center Plug-in for Oracle Essbase...

Documents