IBM Cognos Command Center Plug-in for Oracle HFM Version...
Transcript of IBM Cognos Command Center Plug-in for Oracle HFM Version...
IBM Cognos Command CenterPlug-in for Oracle HFMVersion 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 HFM plug-in overview . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 2. Installing the Oracle HFM plug-in . . . . . . . . . . . . . . . . . . . . 3
Chapter 3. Oracle HFM plug-in configuration . . . . . . . . . . . . . . . . . . . . 5
Chapter 4. Oracle HFM plug-in task reference . . . . . . . . . . . . . . . . . . . 7
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
© Copyright IBM Corp. 2008, 2013 iii
iv IBM Cognos Command Center Plug-in for Oracle HFM 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
vi IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Chapter 1. Oracle HFM plug-in overview
The Oracle HFM plug-in provides a set of task types for monitoring andadministering Oracle Hyperion Financial Management services within IBM CognosCommand Center processes.
Compatibility
The Oracle HFM plug-in is compatible with the following IBM Cognos CommandCenter 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.
The plug-in requires Microsoft .NET Framework 3.5 or higher on MicrosoftWindows agent hosts.
© Copyright IBM Corp. 2008, 2013 1
2 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Chapter 2. Installing the Oracle HFM plug-in
You can install the Oracle HFM plug-in from the menu of the IBM CognosCommand Center client.
Procedure1. Click Tools > Manage Plugin Tasks.2. In the Manage Plugin Tasks window, select the Oracle HFM Plugin.x.x.zip file
in the INSTALLDIR\Plugins directory.3. Click Load file. After the plug-in is installed, the Automation > Oracle > HFM
task and related tasks are available on the Add Task menu in the ProcessEditor.
© Copyright IBM Corp. 2008, 2013 3
4 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Chapter 3. Oracle HFM plug-in configuration
An Oracle HFM computing resource must be configured to use the Oracle HFMplug-in. This resource type represents an Oracle HFM server instance.
The following table shows the arguments for the configuration of the Oracle HFMcomputing resource.
Table 1. Configuration of the Oracle HFM computing resource
Argument Description
Agent The agent that runs all tasks that are related to this resource.
ServerDomain
The server domain.
Server Name The server name.
User ID The user ID that runs tasks.
Password The password for the user.
Homedirectory
The directory to use when processing tasks on this resource.
© Copyright IBM Corp. 2008, 2013 5
6 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Chapter 4. Oracle HFM plug-in task reference
The HFM tasks have arguments that you can specify.
Allocate
The Allocate task allocates the data of an entity across a range of periods.
The following table shows the task arguments for the Allocate task.
Table 2. Task arguments for the Allocate task
Argument Description
ApplicationName
The name of the application.
ScenarioMember
The scenario member.
Year Member The year member.
EntityMember
The entity member.
Start PeriodMember
The start period member.
End PeriodMember
The end period member.
Value Member The value member.
Clear data slice
The Clear Data Slice task clears an HFM data slice based on the configuration file.
The following table shows the task arguments for the Clear Data Slice task.
Table 3. Task arguments for the Clear Data Slice task
Argument Description
Application The name of the application.
DisplayMembers
Specifies whether Display Members are included.
MemberExpansionOnly
Specifies whether Member Expansion is used.
Clear NoneValue
Specifies whether None values are cleared.
Clear EntityCurrencyValue
Specifies whether Entity Currency values are cleared.
ClearDataConfigurationFile
The name of the ClearData configuration file.
© Copyright IBM Corp. 2008, 2013 7
Close period
The Close Period task closes an HFM period.
The following table shows the task arguments for the Close Period task.
Table 4. Task arguments for the Close Period task
Argument Description
ApplicationName
The name of the application.
ScenarioMember
The scenario member.
Year Member The year member.
PeriodMember
The period member.
Close Journals Specifies whether journals are closed.
CloseIntercompany
Specifies whether intercompany items are closed.
Consolidate
The Consolidate task consolidates an entity across a range of periods.
The following table shows the task arguments for the Consolidate task.
Table 5. Task arguments for the Consolidate task
Argument Description
ApplicationName
The name of the application.
ScenarioMember
The scenario member.
Year Member The year member.
EntityMember
The entity member.
Start PeriodMember
The start period member.
End PeriodMember
The end period member.
ConsolidationType
Specifies the consolidation type.
Copy data
The Copy Data task copies data for one or more entities from one set of cells toanother set of cells that are based on the configuration file.
The following table shows the task arguments for the Copy Data task.
8 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Table 6. Task arguments for the Copy Data task
Argument Description
ApplicationName
The name of the application.
DisplayMembers
Specifies whether Display Members are included.
MemberExpansionOnly
Specifies whether Member Expansion is used
Enable LogDetail
Specifies whether Log Detail is enabled.
Show DetailedProcess Log
Specifies whether the detailed process log is shown.
Update Mode Specifies the Update mode.
View Option Specifies the View option.
Copy NoneValue
Specifies whether the None Value is copied.
Copy EntityCurrencyValue
Specifies whether the Entity Currency Value is copied.
Copy CellText
Specifies whether cell text is copied.
Copy DerivedData
Specifies whether derived data is copied.
IgnoreWarning
Specifies whether warnings are ignored.
Factor Specifies the scaling factor.
ConfigurationFile
The name of the configuration File.
Create star schema
The Create Star Schema task creates or updates a relational star schema or flat fileby extracting data from an HFM application.
The following table shows the task arguments for the Create Star Schema task.
Table 7. Task arguments for the Create Star Schema task
Argument Description
ApplicationName
The name of the application.
DisplayMembers
Specifies whether Display Members are included.
Show DetailedProcess Log
Specifies whether the detailed process log is shown.
DestinationDSN
The destination DSN.
Table Prefix An optional table prefix string.
Push Type Specifies whether the table is created or updated.
Chapter 4. Oracle HFM plug-in task reference 9
Table 7. Task arguments for the Create Star Schema task (continued)
Argument Description
ExcludeDynamicAccounts
Specifies whether dynamic accounts are excluded.
ExcludeCalculatedAccounts
Specifies whether calculated accounts are excluded.
Exclude ICPAccounts
Specifies whether ICP accounts are excluded.
Exclude ICPEntity
Specifies whether ICP entities are excluded.
Use DefaultParent
Specifies whether default parents are used.
ConfigurationFile
The name of the configuration file.
Delete star schema
The Delete Star Schema task deletes an HFM Extended Analytics-generated starschema.
The following table shows the task arguments for the Delete Star Schema task.
Table 8. Task arguments for the Delete Star Schema task
Argument Description
ApplicationName
The name of the application.
Star SchemaData SourceName
The star schema data source name.
Table Prefix The table prefix name.
Extract data
The Extract Data task extracts an HFM data slice based on the configuration file.
The following table shows the task arguments for the Extract Data task.
Table 9. Task arguments for the Extract Data task
Argument Description
ApplicationName
The name of the application.
DisplayMembers
Specifies whether Display Members are extracted.
MemberExpansionOnly
Specifies whether Member Expansion Only is used.
DataDelimiter
Defines the data delimiter.
10 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Table 9. Task arguments for the Extract Data task (continued)
Argument Description
ExtractCalculatedData
Specifies whether calculated data is extracted.
View Option Specifies the View option.
File to Extract The name of the file to extract.
ConfigurationFile
The name of the configuration file.
Extract journals
The Extract Journals task extracts HFM journals that are based on a combination ofscenario, year, and period.
The following table shows the task arguments for the Extract Journals task.
Table 10. Task arguments for the Extract Journals task
Argument Description
ApplicationName
The name of the application.
Journals File The name of the journals file to write.
Log File The name of the log file.
Delimiter Defines the data delimiter.
The default value is "," (comma)
ExtractTemplate
The extract template.
The default value is False
ExtractRecurringTemplate
Specifies whether the recurring template is extracted.
The default value is False
ScenarioMember
The scenario member.
Year Member The year member.
PeriodMember
The period member.
Extract member lists
The Extract Member Lists task extracts HFM member lists.
The following table shows the task arguments for the Extract Member Lists task.
Table 11. Task arguments for the Extract Member Lists task
Argument Description
ApplicationName
The name of the application.
Member ListFile
The member list file name.
Chapter 4. Oracle HFM plug-in task reference 11
Table 11. Task arguments for the Extract Member Lists task (continued)
Argument Description
Log File The log file name.
Extract metadata
The Extract Metadata task extracts HFM metadata.
The following table shows the task arguments for the Extract Metadata task.
Table 12. Task arguments for the Extract Metadata task
Argument Description
ApplicationName
The name of the application.
Metadata File The name of the metadata file.
File FormatOptions
Specifies the format of the output file.
Log File The log file name.
Delimiter Defines the data delimiter.
ExtractSystemAccounts
Specifies whether system accounts are extracted.
Extract ICPs Specifies whether ICPs are extracted.
Extract Values Specifies whether values are extracted.
ExtractCurrencies
Specifies whether currencies are extracted.
ExtractAccounts
Specifies whether accounts are extracted.
ExtractEntities
Specifies whether entities are extracted.
ExtractApplicationExtractScenarios
Specifies whether scenarios are extracted.
Settings Specifies whether application settings are extracted.
ExtractConsolidationMethods
Specifies whether consolidation methods are extracted.
ExtractCustom1
Specifies whether Custom1 is extracted.
ExtractCustom2
Specifies whether Custom2 is extracted.
ExtractCustom3
Specifies whether Custom3 is extracted.
ExtractCustom4
Specifies whether Custom4 is extracted.
12 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Extract rules
The Extract Rules task extracts HFM rules.
The following table shows the task arguments for the Extract Rules task.
Table 13. Task arguments for the Extract Rules task
Argument Description
ApplicationName
The name of the application.
Rule File The rule file name.
Log File The log file name.
Extract security
The Extract Security task extracts HFM security.
The following table shows the task arguments for the Extract Security task.
Table 14. Task arguments for the Extract Security task
Argument Description
ApplicationName
The name of the application.
Security File The security file name.
Log File The log file name.
Delimiter Defines the data delimiter.
Extract Usersand Groups
Specifies whether users and groups are extracted.
ExtractSecurityClasses
Specifies whether security classes are extracted.
Extract RoleAccess
Specifies whether role access is extracted.
ExtractSecurity ClassAccess
Specifies whether security class access is extracted.
Load data
The Load Data task loads HFM data.
The following table shows the task arguments for the Load Data task.
Table 15. Task arguments for the Load Data task
Argument Description
ApplicationName
The name of the application.
File and Pathto HFM DataFile
Location of the data file.
Chapter 4. Oracle HFM plug-in task reference 13
Table 15. Task arguments for the Load Data task (continued)
Argument Description
File and Pathto HFM DataFile Log
Location of the log file.
Delimiter Defines the data delimiter.
Log Append Specifies whether the log is appended.
Data LoadMode
Specifies the load mode.
AccumulatedWithin File
Specifies whether the data file contains accumulated values.
ContainedShared Data
Specifies whether the file contains shared data.
Load journals
The Load Journals task loads HFM journals.
The following table shows the task arguments for the Load Journals task.
Table 16. Task arguments for the Load Journals task
Argument Description
ApplicationName
The name of the application.
Journals File The name of the Journals file.
Log File The name of the log file.
Delimiter Defines the data delimiter.
Load lists
The Load Lists task loads HFM lists.
The following table shows the task arguments for the Load Lists task.
Table 17. Task arguments for the Load Lists task
Argument Description
ApplicationName
The name of the application.
Member ListFile
The name of the Member List file.
Log File The name of the log file.
Scan Only Specifies whether only a scan is performed.
Load metadata
The Load Metadata task loads HFM metadata.
The following table shows the task arguments for the Load Metadata task.
14 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Table 18. Task arguments for the Load Metadata task
Argument Description
ApplicationName
The name of the application.
Metadata File The name of the metadata file.
File Format Specifies the format of the output file.
Delimiter Defines the data delimiter.
Prescan Specifies whether the file is prescanned.
CheckIntegrity
Specifies whether integrity is checked.
ClearMetadataBeforeLoading
Specifies whether metadata is cleared before loading.
User ReplaceMode
Specifies whether replace mode is used.
Load SystemAccounts
Specifies whether system accounts are loaded.
Load ICPs Specifies whether ICPs are loaded.
Load Values Specifies whether values are loaded.
LoadCurrencies
Specifies whether currencies are loaded.
LoadAccounts
Specifies whether accounts are loaded.
Load Entities Specifies whether entities are loaded.
LoadScenarios
Specifies whether scenarios are loaded.
LoadApplicationSettings
Specifies whether application settings are loaded.
LoadConsolidationMethods
Specifies whether consolidation methods are loaded.
Load Custom1 Specifies whether Custom1 is loaded.
Load Custom2 Specifies whether Custom2 is loaded.
Load Custom3 Specifies whether Custom3 is loaded.
Load Custom4 Specifies whether Custom4 is loaded.
Load rules
The Load Rules task loads HFM rules.
The following table shows the task arguments for the Load Rules task.
Table 19. Task arguments for the Load Rules task
Argument Description
ApplicationName
The name of the application.
Chapter 4. Oracle HFM plug-in task reference 15
Table 19. Task arguments for the Load Rules task (continued)
Argument Description
Rule File The rule file name.
Log File The log file name.
Scan Only Specifies whether only a scan is performed.
CheckIntercompanyTransactions
Specifies whether to check intercompany transactions.
Load security
The Load Security task loads HFM security.
The following table shows the task arguments for the Load Security task.
Table 20. Task arguments for the Load Security task
Argument Description
ApplicationName
The name of the application.
Security File The security file name.
Log File The log file name.
Delimiter Defines the data delimiter.
Clear SecurityInformationBeforeLoading
Specifies whether security information is cleared before the file is loaded.
Load Usersand Groups
Specifies whether users and groups are loaded.
Load SecurityClasses
Specifies whether security classes are loaded.
Load RoleAccess
Specifies whether role access is loaded.
Load SecurityClass Access
Specifies whether security class access is loaded.
Validate Users Specifies whether users are validated.
Translate
The Translate task allocates the data of an entity across a range of periods.
The following table shows the task arguments for the Translate task.
Table 21. Task arguments for the Translate task
Argument Description
ApplicationName
The name of the application.
ScenarioMember
The scenario member.
Year Member The year member.
16 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
Table 21. Task arguments for the Translate task (continued)
Argument Description
EntityMember
The entity member.
Start PeriodMember
The start period member.
End PeriodMember
The end period member.
ValidationMember
The validation member.
Use Force If True, performs translation even if already translated.
The default value is False.
Chapter 4. Oracle HFM plug-in task reference 17
18 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
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.
© Copyright IBM Corp. 2008, 2013 19
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.
20 IBM Cognos Command Center Plug-in for Oracle HFM Version 10.2.0: User Guide
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.
Notices 21