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

IBM Cognos Command CenterPlug-in for Oracle Hyperion PlanningVersion 10.2.0

User Guide

��

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

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 Hyperion Planning plug-in overview. . . . . . . . . . . . . . . . 1

Chapter 2. Installing the Oracle Hyperion Planning plug-in . . . . . . . . . . . . . . 3

Chapter 3. Oracle Hyperion Planning plug-in configuration. . . . . . . . . . . . . . 5Creating a password file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 4. Oracle Hyperion Planning plug-in task reference . . . . . . . . . . . . . 7

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

© Copyright IBM Corp. 2008, 2013 iii

iv IBM Cognos Command Center Plug-in for Oracle Hyperion Planning 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.jsp

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

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

Chapter 1. Oracle Hyperion Planning plug-in overview

The Oracle Hyperion Planning plug-in provides a set of task types for runningvarious administrative functions in Oracle Hyperion Planning.

These administrative functions include the following tasks:v Broadcast Messagev Refresh Planningv Unlock Planningv Import Formsv Export Formsv Import / Export Single Formv Import Securityv Export Securityv Copy Data (including Hyperion Planning supporting detail)v Set Login Level

You can sequence these functions with other tasks for a comprehensive andeasy-to-maintain automation routine.

Compatibility

The Oracle Hyperion Planning plug-in is compatible with the following IBMCognos Command 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 the Microsoft Windows operating system.

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

Oracle Hyperion Planning9.3.x or higher (use Oracle Planning 9.3.x plug-in)

11.1.2.x or higher (use Oracle Planning 11.1.2.x plug-in)

The plug-in requires a Java environment to be present on the agent hosts. OnWindows, the IBM Cognos Command Center 10.1 agent (or higher) comes withJava, and on UNIX, Java must be installed separately. For more information, seethe IBM Cognos Command Center Agent for UNIX Installation Guide.

© Copyright IBM Corp. 2008, 2013 1

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

Chapter 2. Installing the Oracle Hyperion Planning plug-in

You can install the Oracle Hyperion Planning plug-in from the menu of the IBMCognos Command Center client.

Procedure1. Click Tools > Manage Plugin Tasks.2. In the Manage Plugin Tasks window, select the Oracle Planning

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

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



Chapter 3. Oracle Hyperion Planning plug-in configuration

To use the tasks in the Oracle Hyperion Planning plug-in, a specific hostcomputing resource must be configured.

Attention: Different configurations depend on your version of Oracle HyperionPlanning.

The following table shows the arguments for the configuration of the computingresource with Oracle Planning 9.3.x or greater.

Table 1. Configuration of the computing resource with Oracle Planning 9.3.x or greater.

Argument Description

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

Planninghome

The Oracle Hyperion Planning directory under the root of Hyperion Home.For example, C:\Hyperion\Planning.

Hyperioncommon

The Oracle Hyperion common directory under the root of Hyperion Home.For example, C:\Hyperion\common.

Windowshome

The Windows directory.

The default is C:\WINDOWS.

Server The Oracle Planning server host name.

The following table shows the arguments for the configuration of the computingresource with Oracle Planning 11.1.x or greater.

Table 2. Configuration of the computing resource with Oracle Planning 11.1.x or greater


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

Planninghome

The Oracle Hyperion Planning directory under user_projects. Forexample, D:\Oracle\Middleware\user_projects\epmsystem1\Planning\planning1.

Windowshome

The Windows directory.

The default is C:\WINDOWS.

Server The Oracle Planning server host name.

Creating a password fileMany of the functions of the Oracle Hyperion Planning plug-in use the planningutilities that are included with the product.

Starting in version 11.x of Oracle Hyperion Planning, you can create an encryptedpassword file. The password file is then referenced as an argument in the setup ofa task.


Procedure1. Open a command prompt and go to the location where the Hyperion Planning

utilities exist. Typically, this location is in the Oracle Hyperion commondirectory under the root of Hyperion Home. For example, C:\Hyperion\common.

2. Run the command PasswordEncryption.cmd with a single parameter for thename of the password file.

3. When prompted to enter the system password, type in the password of theuser that runs the various Planning functions.The contents of the file have a single encrypted value.

4. The password file can be used without being changed. A good practice is to usethe encrypted string for the value of an IBM Cognos Command Centerecosystem variable and use this variable in a Cognos Command Center fileresource.

5. If the value of the password changes, repeat the steps and replace the value ofthe variable.


Chapter 4. Oracle Hyperion Planning plug-in task reference

The Planning tasks have arguments that you can specify.

Broadcast message

The Broadcast Message task displays a message to all Oracle Hyperion Planningusers who are logged on to Hyperion Planning. This task notifies users thatactivity is about to occur, such as a Planning maintenance update.

Table 3. Task arguments for the Broadcast Message task


User The Oracle Hyperion Planning user.

Password File The path and file name of the password file. For more information, see“Creating a password file” on page 5.

Application The Oracle Hyperion Planning application.

Message The text to display in a message.

Refresh planning

The Refresh Planning task synchronizes Oracle Hyperion Planning applicationupdates to Oracle Essbase.

Table 4. Task arguments for the Refresh Planning task





Processdatabase

Push metadata changes from Oracle Hyperion Planning to Oracle Essbase.

The default value is Yes.

Refresh filters Push security filter changes from Oracle Hyperion Planning to OracleEssbase.

The default value is No.

Refresh filters(shared)

Push shared security filter changes from Oracle Hyperion Planning toOracle Essbase.


Validate filters Validate filters during synchronization.



Unlock planning

The Unlock Planning task unlocks the Oracle Hyperion Planning application.

Table 5. Task arguments for the Unlock Planning task





Export forms

The Export Forms task exports Oracle Hyperion Planning web forms in XMLformat to the Hyperion Planning home directory.

Table 6. Task arguments for the Export Forms task





Import forms

The Import Forms task imports Oracle Hyperion Planning web forms from XMLfiles in the Hyperion Planning home directory.

Table 7. Task arguments for the Import Forms task





Import / export single form

The Import / Export Single Form task performs a single Oracle Hyperion Planningweb form import or export.

Table 8. Task arguments for the Import / Export Single Form task





Operation A list of the two available operations: Export or Import.

File / Form Depending on whether the operation is an Export or an Import, either afile name (FormName.xml) or form name is accepted.


Export security

The Export Security task performs an Oracle Hyperion Planning security export.

Table 9. Task arguments for the Export Security task





File Export file name and location.

Delimiter A list of supported delimiters: Comma, Pipe, Colon, and Semi-colon.

The default is comma.

Search criteria Optional string to filter security export.

Import security

The Import Security task performs an Oracle Hyperion Planning security import.This function accepts only a file named secfile.txt in the Hyperion homedirectory.

Table 10. Task arguments for the Import Security task





Delimiter A list of supported delimiters: Comma, Pipe, Colon, and Semi-colon.

The default is comma.

Clear security Drop down with a Yes/No toggle.

The default value is Yes.

Copy Data

The Copy Data task replicates the Oracle Hyperion Planning copy datafunctionality, but as a fully automated task.

Table 11. Task arguments for the Copy Data task



Password The Oracle Hyperion Planning user password.


Configurationfile

Path and file name of the configuration file. For more information, see thesection Example setup of the copy data task. A good practice is to make this afile resource of the task.

Chapter 4. Oracle Hyperion Planning plug-in task reference 9

Table 11. Task arguments for the Copy Data task (continued)


Verboselogging

Drop down with a Yes/No toggle.


Example setup of the copy data task

The following is an example configuration file for the copy data task:SCC_HP_STATICDIMS=account,Period,Currency,Channels,Entity,Segments,VersionSCC_HP_STATICDIMS_ACCOUNT=503100,502100,504100,504200,504300SCC_HP_STATICDIMS_PERIOD=IChildren(YearTotal)SCC_HP_STATICDIMS_CURRENCY=LocalSCC_HP_STATICDIMS_CHANNELS=No ChannelSCC_HP_STATICDIMS_ENTITY=E01_101_1120,E01_101_1110SCC_HP_STATICDIMS_SEGMENTS=NoSegmentSCC_HP_STATICDIMS_VERSION=Working

SCC_HP_SRC_TRGDIMS=Year,ScenarioSCC_HP_SRC_TRGDIMS_SRC_YEAR=FY08SCC_HP_SRC_TRGDIMS_TRG_YEAR=FY09SCC_HP_SRC_TRGDIMS_SRC_SCENARIO=ActualSCC_HP_SRC_TRGDIMS_TRG_SCENARIO=Actual

SCC_HP_SDT=TRUESCC_HP_ANN=TRUESCC_HP_TXT=TRUESCC_HP_PLN_TYPE=Plan1


Attention: There are three primary sections of the configuration file - Staticdimensions, Source and Target dimensions, and Copy Options.

All dimensions must be referenced either in the SCC_HP_STATICDIMS orSCC_HP_SRC_TRGDIMS parameters (sections 1 and 2).

In the first two sections, the parameters SCC_HP_STATICDIMS_,SCC_HP_SRC_TRGDIMS_SRC_, and SCC_HP_SRC_TRGDIMS_SRC_ are constructed by usingthe dimension for the final string of characters.

If a dimension or member name has a space in the name, then use a backslash (\)in the name. For example, COST\CENTER.

The following expansion functions are available for the Static dimensions:v Descendants(MemberName)

v IDescendants(MemberName)

v Ancestors(MemberName)

v IAncestors(MemberName)

v Siblings(MemberName)

v ISiblings(MemberName)

v Parents(MemberName)

v IParents(MemberName)

v Children(MemberName)

v IChildren(MemberName)

v ILvl0Descendants(MemberName)

Replace MemberName with the appropriate name.

In the third section, the following parameters control which data types are copied.Replace the TRUE or FALSE variable to toggle the wanted operation.

Copy Supporting DetailSCC_HP_SDT=TRUE

Copy AnnotationsSCC_HP_ANN=TRUE

Copy CommentsSCC_HP_TXT=TRUE

In the third section, the following parameter controls which plan type is used.Either the plan type name or number can be used.

Planning "Plan Type"SCC_HP_PLN_TYPE=Plan1

IBM Cognos Command Center variables can be used anywhere in the file.

Set Login Level

The Set Login Level task replicates the ability to set the Login Level formaintenance mode in the Oracle Hyperion Planning application as a fullyautomated task.

Chapter 4. Oracle Hyperion Planning plug-in task reference 11

Table 12. Task arguments for the Set Login Level task



Password The Oracle Hyperion Planning user password.


Login level Drop-down list of the three Planning Login Levels: All users,Administrators, Owner.

The default value is All users.

Verboselogging

Drop-down with a Yes/No toggle.



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 15

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

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

Date post:	21-Sep-2020
Category:	Documents
Upload:	others
View:	5 times
Download:	0 times

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

Documents