O R A C L E H Y P E R I O N E N T E R P R I S E P E R F O R M A N C E M A N A G E M E N T S Y S T E M

Size: px

Start display at page:

Download "O R A C L E H Y P E R I O N E N T E R P R I S E P E R F O R M A N C E M A N A G E M E N T S Y S T E M"

Pierce Allison
5 years ago
Views:

I C F I N A N C E, F U S I O N E D I T I O N R E L E A S E 1

1 O R A C L E H Y P E R I O N E N T E R P R I S E P E R F O R M A N C E M A N A G E M E N T S Y S T E M O R A C L E H Y P E R I O N S T R A T E G I C F I N A N C E, F U S I O N E D I T I O N R E L E A S E H S F W E B S E R V I C E S A P I D E V E L O P E R ' S G U I D E

2 Strategic Finance HSF Web Services API Deveoper's Guide, Copyright 1996, 2009, Orace and/or its affiiates. A rights reserved. Authors: EPM Information Deveopment Team This software and reated documentation are provided under a icense agreement containing restrictions on use and discosure and are protected by inteectua property aws. Except as expressy permitted in your icense agreement or aowed by aw, you may not use, copy, reproduce, transate, broadcast, modify, icense, transmit, distribute, exhibit, perform, pubish or dispay any part, in any form, or by any means. Reverse engineering, disassemby, or decompiation of this software, uness required by aw for interoperabiity, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, pease report them to us in writing. If this software or reated documentation is deivered to the U.S. Government or anyone icensing it on behaf of the U.S. Government, the foowing notice is appicabe: U.S. GOVERNMENT RIGHTS: Programs, software, databases, and reated documentation and technica data deivered to U.S. Government customers are "commercia computer software" or "commercia technica data" pursuant to the appicabe Federa Acquisition Reguation and agency-specific suppementa reguations. As such, the use, dupication, discosure, modification, and adaptation sha be subject to the restrictions and icense terms set forth in the appicabe Government contract, and, to the extent appicabe by the terms of the Government contract, the additiona rights set forth in FAR , Commercia Computer Software License (December Orace USA, Inc., 500 Orace Parkway, Redwood City, CA This software is deveoped for genera use in a variety of information management appications. It is not deveoped or intended for use in any inherenty dangerous appications, incuding appications which may create a risk of persona injury. If you use this software in dangerous appications, then you sha be responsibe to take a appropriate fai-safe, backup, redundancy and other measures to ensure the safe use of this software. Orace Corporation and its affiiates discaim any iabiity for any damages caused by use of this software in dangerous appications. This software and documentation may provide access to or information on content, products and services from third parties. Orace Corporation and its affiiates are not responsibe for and expressy discaim a warranties of any kind with respect to third party content, products and services. Orace Corporation and its affiiates wi not be responsibe for any oss, costs, or damages incurred due to your access to or use of third party content, products or services.

3 Contents Chapter 1. HSF Web Services API Overview... 5 Overview... 5 Discaimer... 5 Compatibe Programming Frameworks... 5 Architecture... 6 Fies and Directories... 6 HYPERION_HOME\StrategicFinance\Server\hsfwebservices \hsfwebservices\bin... 6 Logging... 7 Registry Settings... 7 Depoying HSF Web Services... 7 Test Pages... 8 Exampe Using the Test Pages... 8 Accessing the HSF Web Services Test Page... 8 Returning a SessionID... 8 Returning a List of HSF Servers... 9 Accessing an HSF Server... 9 Chapter 2. HSF Web Services API Cass Diagram HSFWebService Pubic Constructors HSFWebService Genera Functions EnumServers Server Functions EnumDatabases EnumOpenedEntities OpenServer CoseServer Database Functions CoseAEntities Contents iii

4 CoseDatabase EnumCubes EnumEntities OpenDatabase Session Functions CreateSession CreateSessionFromToken CoseSession GetSessionInfo HSFEntityWebService Pubic Constructors HSFEntityWebService Pubic Functions CreateEntity OpenEntity CoseEntity EnumAccounts EnumCustomDimensions EnumCustomMembers EnumScenarios EnumTimePeriods EnumMeasures GetEntityDataCes SetEntityDataCes GetEntityLockInfo ReeaseEntityLock Cacuate ExportExtendedAnaytics Chapter 3. Sampe Code C# in Active Server Pages IncomeStatement.aspx iv Contents

5 1 HSF Web Services API Overview In This Chapter Overview...5 Architecture...6 Fies and Directories...6 Registry Settings...7 Depoying HSF Web Services...7 Test Pages...8 Overview Orace Hyperion Strategic Finance, Fusion Edition Web Services is C# API (Appication Programming Interface for accessing and interacting with entities on Strategic Finance servers. This guide is to hep deveopers understand how to use Strategic Finance Web Services to create web-enabed software that accesses Strategic Finance data. It enabes integration with other Orace Hyperion Enterprise Performance Management System products, such as: Orace Hyperion Financia Data Quaity Management, Fusion Edition Discaimer The HSF Web Services API is subject to change. Compatibe Programming Frameworks The HSF Gateway is buit with Microsoft.NET, so it is compatibe with.net frameworks, such as: C# Visua Basic Overview 5

$HYPERION_HOME\StrategicFinance\Server \hsfwebservices Contains the foowing: HSFWebService.asmx The web service HSFEntityWebServices.asmx The entity web service web.config Configuration fie.$

6 Architecture Figure 1 Architecture Fies and Directories Strategic Finance Web Services is instaed aong with the Strategic Finance server. This section ists the directories and fies they contain. HYPERION_HOME\StrategicFinance\Server \hsfwebservices Contains the foowing: HSFWebService.asmx The web service HSFEntityWebServices.asmx The entity web service web.config Configuration fie..\hsfwebservices\bin Contains the foowing: HSFGateway.d Contains the Gateway casses HSFGatewayCommunication.d Contains the gateway communication casses HSFGatewayWrapper.d Contains the gateway wrapper casses HSFWebServices.d 6 HSF Web Services API Overview

7 Contains the HSF Web Services casses Interop.HSFGatewayLib.d Contains casses for use with Orace's Hyperion Shared Services and other Orace Hyperion Enterprise Performance Management System products Logging For information on ogging, search the web for using the GetTempPath function to ocate the temporary ogging directory. Registry Settings fie directory Directory containing the gateway og fie og Determines whether the Gateway wi og errors and actions m m true Log errors and actions fase Do not og og fie name Fiename of the Gateway og network address HSF server IP address port HSF server port protoco Vaid vaues: m ncacn_ip_tcp server name Name of the HSFServer returned by EnumServers. Maximum: 1 Depoying HSF Web Services HSF Web Services are instaed with the HSF server. Registry Settings 7

8 ä To depoy HSF Web Services: 1 Insta prerequisites: Microsoft Internet Information Services On Windows Server patforms, configure IIS to aow Active Server Pages. 2 Insta HSF Server: Choose Custom instead of typica and make sure Web API Service is checked. If it reboots in the midde of the insta, it may need to be re-instaed. Test Pages HSF Web Services provides web pages you can use in testing and earning the API. These pages are accessibe ony on the oca machine. You can access these pages using a browser on the oca machine to access the foowing URLs: HSF Web Services Test Page HSF Entity Web Services Test Page These pages provides inks showing most of the functions avaiabe, the parameters you can pass, and an exampe of the SOAP request and response. In addition, you can enter parameters and submit the request to HSF Web Services in order to obtain a response and see how the code behaves. Exampe Using the Test Pages Accessing the HSF Web Services Test Page ä To access the test pages: 1 On the oca machine running HSF Web Services, open a browser. 2 Access the foowing URL: Returning a SessionID You wi need a SessionID to perform a of the functions in the test pages. 8 HSF Web Services API Overview

9 ä To return a SessionID: 1 From the HSF Web Services test page, cick Create Session. 2 In username, enter a user. 3 In password, enter a password. 4 Cick Invoke. When you cick Invoke, you wi receive a SOAP response containing a string, which represents a SessionID. You can copy and paste this SessionID for use with a other function test pages. Returning a List of HSF Servers ä To return a ist of HSF Servers: 1 From the HSF Web Services test page, cick EnumServers. 2 In sessionid, enter a sessionid. 3 Cick Invoke. Accessing an HSF Server ä To access an HSF server: 1 From the HSF Web Services test page, cick OpenServer. 2 In sessionid, enter a sessionid. 3 In server, enter an HSF server name. 4 Cick Invoke. For many functions, success is indicated by a bank page, meaning that no error has been returned, but there is no other return vaue to view, as with a successfu server ogon. Test Pages 9

10 10 HSF Web Services API Overview

11 2 HSF Web Services API In This Chapter Cass Diagram...11 HSFWebService...11 HSFEntityWebService...25 Cass Diagram HSFWebService Contains functions for accessing Orace Hyperion Strategic Finance, Fusion Edition servers and databases. Pubic Constructors HSFWebService Initiaizes a new instance of the WebServices cass. Cass Diagram 11

12 C# Visua Basic Pubic Sub New( pubic HSFWebService( pubic: HSFWebService( seaed pubic function HSFWebService( None HSFWebService object Exampe See IncomeStatement.aspx on page 43. Genera Functions EnumServers Description: a ist of servers for the HSFWebService. Pre-requisites: CreateSession( C# Visua Basic Pubic Function EnumServers( _ ByVa sessionid As String _ As String( pubic string[] EnumServers( string sessionid pubic: array<>^ EnumServers( String sessionid seaed 12 HSF Web Services API

13 pubic function EnumServers( sessionid : String : String[] Tabe 1 EnumServers sessionid string A session identifier A ist of servers Exampe See IncomeStatement.aspx on page 43. Server Functions These functions access HSF servers. EnumDatabases Description: a ist of databases for the server currenty open in the HSFWebService. Pre-requisites: CreateSession( and OpenServer(. C# Visua Basic Pubic Function EnumDatabases( _ ByVa sessionid As String _ As String( pubic string[] EnumDatabases( string sessionid array<string>^ EnumDatabases( String sessionid seaed pubic function EnumDatabases( sessionid : String : String[] HSFWebService 13

14 Tabe 2 EnumDatabases sessionid string A session identifier HSFWebService object Exampe See IncomeStatement.aspx on page 43. EnumOpenedEntities Description: Enumerates entities opened in the current HSF server. Pre-requisites: CreateSession( pubic DataSet EnumOpenedEntities(string sessionid C# Visua Basic Pubic Function EnumOpenedEntities( _ ByVa sessionid As String _ As DataSet pubic DataSet EnumOpenedEntities( string sessionid pubic: DataSet EnumOpenedEntities( String sessionid seaed pubic function EnumOpenedEntities( sessionid : String : DataSet Tabe 3 EnumOpenedEntities sessionid string A session identifier 14 HSF Web Services API

15 HSFWebService object OpenServer Description: Opens a connection to a specified HSF Server. Pre-requisites: CreateSession(, OpenServer(, OpenDatabase( and OpenCube(. C# Visua Basic Pubic Sub OpenServer( _ ByVa sessionid As String, _ ByVa server As String _ pubic void OpenServer( string sessionid, string server pubic: void OpenServer( String sessionid, String server seaed pubic function OpenServer( sessionid : String, server : String Tabe 4 OpenServer sessionid string A session identifier server string An HSF server name void Success Error message Faiure HSFWebService 15

16 Exampe See IncomeStatement.aspx on page 43. CoseServer Description: Coses the server currenty open in the HSFWebService. Pre-requisites: CreateSession( and OpenServer(. C# Visua Basic Pubic Sub CoseServer( _ ByVa sessionid As String _ pubic void CoseServer( string sessionid pubic: void CoseServer( String sessionid seaed pubic function CoseServer( sessionid : String Tabe 5 CoseServer sessionid string A session identifier void Success Error message Faiure Database Functions These functions access HSF databases. 16 HSF Web Services API

17 CoseAEntities Description: Coses a entities in the database currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. C# Visua Basic Pubic Sub CoseAEntities( _ ByVa sessionid As String, _ ByVa checkin As Booean, _ ByVa reeaselock As Booean _ pubic void CoseAEntities( string sessionid, boo checkin, boo reeaselock pubic: void CoseAEntities( String sessionid, boo checkin, boo reeaselock seaed pubic function CoseAEntities( sessionid : String, checkin : boo, reeaselock : boo Tabe 6 CoseAEntities sessionid string A session identifier checkin boo True check in entity Fase do not check in reeaselock boo True reease ock Fase retain ock void HSFWebService 17

18 Success Error message Faiure CoseDatabase Description: Coses the database currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. C# Visua Basic Pubic Sub CoseDatabase( _ ByVa sessionid As String _ pubic void CoseDatabase( string sessionid pubic: void CoseDatabase( String sessionid seaed pubic function CoseDatabase( sessionid : String Tabe 7 CoseDatabase sessionid string A session identifier void Success Error message Faiure 18 HSF Web Services API

19 EnumCubes Description: a ist of cubes for the database currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. C# Visua Basic Pubic Function EnumCubes( _ ByVa sessionid As String _ As String( pubic string[] EnumCubes( string sessionid pubic: array<string>^ EnumCubes( String sessionid seaed pubic function EnumCubes( sessionid : String : String[] Tabe 8 EnumCubes sessionid string A session identifier HSFWebService object EnumEntities Description: a ist of entities for the database currenty open in the HSF Gateway. If an entity is specified, the ist wi contain ony ancestors of that entity. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. Visua Basic Pubic Function EnumEntities( _ ByVa sessionid As String, _ ByVa entity As String, _ HSFWebService 19

20 C# ByVa action As String _ As String( pubic string[] EnumEntities( string sessionid, string entity, string action pubic: array<string>^ EnumEntities( String sessionid, String entity, String action seaed pubic function EnumEntities( sessionid : String, entity : String, action : String : String[] Tabe 9 EnumEntities sessionid string A session identifier entity string An entity namean empty string ( indicates starting at the root. action string Use one of the foowing: <bank> (defaut or a Enumerates a entities chidren Enumerates down to the chidren descendents Enumerates down to descendents A ist of entities in the open database Exampe See IncomeStatement.aspx on page HSF Web Services API

21 OpenDatabase Description: Opens a database in the server currenty open in the HSFWebService. Prerequisites: CreateSession( and OpenServer(. C# Visua Basic Pubic Sub OpenDatabase( _ ByVa sessionid As String, _ ByVa database As String _ pubic void OpenDatabase( string sessionid, string database pubic: void OpenDatabase( String sessionid, String database seaed pubic function OpenDatabase( sessionid : String, database : String Tabe 10 OpenDatabase sessionid string A session identifier database string A database name void Success Error message Faiure Exampe See IncomeStatement.aspx on page 43. HSFWebService 21

22 Session Functions Currenty unavaiabe. CreateSession Description: Creates a session for the given user/password on the HSFWebServices. Prerequisites: None. Visua Basic C# pubic string CreateSession(string username, string password Tabe 11 CreateSession username string A user name password string The user's password A session string Exampe See IncomeStatement.aspx on page 43. CreateSessionFromToken Description: Creates a session for the given Orace's Hyperion Shared Services Singe Sign-on token on the HSFWebServices. Prerequisites: None. C# Visua Basic pubic string CreateSessionFromToken(string token 22 HSF Web Services API

23 Tabe 12 token string A CSS token A session string Exampe See. CoseSession Description: Coses the given session currenty open in the HSFWebService. Prerequisites: CreateSession(. C# Visua Basic Pubic Sub CoseSession( _ ByVa sessionid As String _ pubic void CoseSession( string sessionid pubic: void CoseSession( String sessionid seaed pubic function CoseSession( sessionid : String HSFWebService 23

24 Tabe 13 CoseSession sessionid string A session identifier void Success Error message Faiure Exampe See. GetSessionInfo Description: Retrieves information about the user session incuding token. Prerequisites: CreateSession(. C# Visua Basic Pubic Function GetSessionInfo( _ ByVa sessionid As String _ As DataSet pubic DataSet GetSessionInfo( string sessionid pubic: DataSet GetSessionInfo( String sessionid seaed pubic function GetSessionInfo( sessionid : String : DataSet 24 HSF Web Services API

25 Tabe 14 GetSessionInfo sessionid string A session identifier void HSFEntityWebService Pubic Constructors HSFEntityWebService Creates an instance of an entity web services, for accessing HSF entities. Visua Basic C# pubic HSFEntityWebService( None An HSFEntityWebService object Pubic Functions CreateEntity Description: Creates a new entity. It can be paced in a structure by optionay incuding root and parent entity names. The there is a fag to retain data from within the source entity in the new entity. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. HSFEntityWebService 25

26 C# Visua Basic Pubic Function CreateSession( _ ByVa sessionid As String, _ ByVa username As String, _ ByVa password As String, _ ByVa token As String _ As String pubic string CreateSession( string sessionid, string username, string password, string token pubic: String CreateSession( String sessionid, String username, String password, String token seaed pubic function CreateSession( sessionid : String, username : String, password : String, token : String : String Tabe 15 CreateSession sessionid string A session identifier newentity string A name for the new entity baseentity string A source entity from which to copy the new entity rootentity string The root entity of the tree parententity string The entity under which to create the new entity keepdata boo Indicates whether or not to copy the data from the baseentity void 26 HSF Web Services API

27 OpenEntity Description: Opens an entity in the database currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer( and OpenDatabase(. C# Visua Basic Pubic Function OpenEntity( _ ByVa sessionid As String, _ ByVa entity As String, _ ByVa checkout As Booean _ As DataSet pubic DataSet OpenEntity( string sessionid, string entity, boo checkout pubic: DataSet OpenEntity( String sessionid, String entity, boo checkout seaed pubic function OpenEntity( sessionid : String, entity : String, checkout : boo : DataSet Tabe 16 sessionid string A session identifier entity string An entity name checkout boo True check out entity Fase open as copy DataSet HSFEntityWebService 27

28 Tabe 17 OpenEntity DataSet Name String Name of entity IsCheckedOut booean Checked out status: true Is checked out fase Is not checked out Exampe See IncomeStatement.aspx on page 43. CoseEntity Description: Coses the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Sub CoseEntity( _ ByVa sessionid As String, _ ByVa checkin As Booean, _ ByVa reeaselock As Booean _ pubic void CoseEntity( string sessionid, boo checkin, boo reeaselock pubic: void CoseEntity( String sessionid, boo checkin, boo reeaselock seaed pubic function CoseEntity( sessionid : String, checkin : boo, reeaselock : boo 28 HSF Web Services API

29 Tabe 18 CoseEntity sessionid string A session identifier checkin boo True check in entity Fase do not check in reeaselock boo True reease ock Fase retain ock void Success Error message Faiure EnumAccounts Description: a ist of accounts for the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Function EnumAccounts( _ ByVa sessionid As String _ As DataSet pubic DataSet EnumAccounts( string sessionid pubic: DataSet EnumAccounts( String sessionid seaed pubic function EnumAccounts( sessionid : String : DataSet HSFEntityWebService 29

30 Tabe 19 EnumAccounts sessionid string A session identifier DataSet Tabe 20 EnumAccounts DataSet ID string Account ID Name string Account name Number string Account number IsInput booean Indicates if the account is an input or an output: true Input account fase Output account Exampe See IncomeStatement.aspx on page 43. EnumCustomDimensions C# Visua Basic pubic DataSet EnumCustomDimensions( string sessionid None DataSet 30 HSF Web Services API

31 Tabe 21 EnumCustomDimensions DataSet Name string Custom dimension name Exampe See. EnumCustomMembers C# Visua Basic pubic DataSet EnumCustomMembers( string sessionid, string dimension, string parent, string action None DataSet Tabe 22 EnumCustomMembers DataSet ID string Custom member ID ParentID string Pointer to parent custom member, if it exists Name string Custom member name IsParent boo Indicates if the custom member is a parent: IsInput boo Indicates if?: true Is parent with chidren fase Has no chidren HSFEntityWebService 31

32 true? fase? EnumScenarios Description: a ist of scenarios for the entity currenty open in the HSF Gateway. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Function EnumScenarios( _ ByVa sessionid As String _ As DataSet pubic DataSet EnumScenarios( string sessionid pubic: DataSet EnumScenarios( String sessionid seaed pubic function EnumScenarios( sessionid : String : DataSet Tabe 23 sessionid string A session identifier DataSet 32 HSF Web Services API

33 Tabe 24 EnumScenarios DataSet ID string Scenario ID Name string Scenario name Exampe See IncomeStatement.aspx on page 43. EnumTimePeriods Description: a ist of time periods for the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Function EnumTimePeriods( _ ByVa sessionid As String _ As DataSet pubic DataSet EnumTimePeriods( string sessionid pubic: DataSet EnumTimePeriods( String sessionid seaed pubic function EnumTimePeriods( sessionid : String : DataSet Tabe 25 EnumTimePeriods sessionid string A session identifier DataSet HSFEntityWebService 33

34 Tabe 26 EnumTimePeriods DataSet ID string Time Period ID ParentID string Pointer to parent Time Period, if it exists Name string Time Period name IsParent boo Indicates if the time period is a parent: IsInput boo Indicates if?: true Is parent with chidren fase Has no chidren true? fase? Exampe See IncomeStatement.aspx on page 43. EnumMeasures Description: a ist of measures, whether the vaue is an input or an output in the entity, for the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Function EnumMeasures( _ ByVa sessionid As String _ As DataSet pubic DataSet EnumMeasures( string sessionid DataSet EnumMeasures( String sessionid seaed 34 HSF Web Services API

35 pubic function EnumMeasures( sessionid : String : DataSet Tabe 27 sessionid string A session identifier DataSet Tabe 28 EnumMeasures DataSet ID string Measure ID Name string Measure name Exampe See. GetEntityDataCes Description: a DataSet containing information from ces in the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Function GetEntityDataCes( _ ByVa sessionid As String, _ ByVa datacelocators As DataSet _ As DataSet pubic DataSet GetEntityDataCes( string sessionid, DataSet datacelocators pubic: DataSet GetEntityDataCes( String sessionid, HSFEntityWebService 35

36 DataSet datacelocators seaed pubic function GetEntityDataCes( sessionid : String, datacelocators : DataSet : DataSet Tabe 29 GetEntityDataCes sessionid string A session identifier datacelocators DataSet A ist of ce ocations mapping to a DataTabe DataSet Tabe 30 GetEntityDataCes DataSet Vaue string Vaue in ce Account string Account row for ce Time string Time period of ce Scenario string Scenario of ce Measure string Measure of ce IsVaid boo?? CanRead boo?? CanWrite boo?? Exampe See IncomeStatement.aspx on page 43. SetEntityDataCes Description: Sends data to the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenCube(. 36 HSF Web Services API

37 C# Visua Basic Pubic Sub SetEntityDataCes( _ ByVa sessionid As String, _ ByVa dataceinfos As DataSet _ pubic void SetEntityDataCes( string sessionid, DataSet dataceinfos pubic: void SetEntityDataCes( String sessionid, DataSet dataceinfos seaed pubic function SetEntityDataCes( sessionid : String, dataceinfos : DataSet Tabe 31 GetEntityDataCes sessionid string A session identifier dataceinfos DataSet A ist of ce ocations mapping to a DataTabe DataSet Tabe 32 GetEntityDataCes DataSet Vaue string Vaue in ce Account string Account row for ce Time string Time period of ce Scenario string Scenario of ce Measure string Measure of ce CustomMembers string?? HSFEntityWebService 37

38 IsVaid boo?? Cause string?? Exampe See. GetEntityLockInfo the name of the user hoding the ock on the entity. C# Visua Basic pubic string GetEntityLockInfo( string sessionid, string Entity Tabe 33 GetEntityLockInfo sessionid string A session identifier Entity string Name of entity string ReeaseEntityLock C# Visua Basic pubic boo ReeaseEntityLock( string sessionid, string entity 38 HSF Web Services API

39 Tabe 34 ReeaseEntityLock sessionid string A session identifier Entity string Name of entity void Exampe See IncomeStatement.aspx on page 43. Cacuate Description: Cacuates the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Sub Cacuate( _ ByVa sessionid As String, _ ByRef normacac As Booean, _ ByRef reversecac As Booean _ pubic void Cacuate( string sessionid, boo normacac, boo reversecac pubic: void Cacuate( String sessionid, boo% normacac, boo% reversecac seaed pubic function Cacuate( sessionid : String, HSFEntityWebService 39

40 normacac : boo, revercac : boo Cacuate Tabe 35 sessionid string A session identifier normacac booean If true, performs a norma cacuation. reversecac booean If true, performs a reverse cacuation.reverse cacuations are performed first. DataSet Tabe 36 EnumMeasures DataSet Message string The message IsError boo??? true Message is an error fase Message is not an error ExportExtendedAnaytics Description: Does an extended anaytics export for the entity currenty open in the HSFWebService. Prerequisites: CreateSession(, OpenServer(, OpenDatabase( and OpenEntity(. C# Visua Basic Pubic Sub ExportExtendedAnaytics( _ ByVa sessionid As String, _ ByVa anaysisversion As String _ pubic void ExportExtendedAnaytics( string sessionid, string anaysisversion 40 HSF Web Services API

41 pubic: void ExportExtendedAnaytics( String sessionid, String anaysisversion seaed pubic function ExportExtendedAnaytics( sessionid : String, anaysisversion : String Tabe 37 ExportExtendedAnaytics sessionid string A session identifier anaysisversion string An Extended Anaytics name void Success Error message Faiure HSFEntityWebService 41

42 42 HSF Web Services API

43 3 Sampe Code In This Chapter C# in Active Server Pages...43 C# in Active Server Pages IncomeStatement.aspx Page Language="C#" %> <!DOCTYPE htm PUBLIC "-//W3C//DTD XHTML 1.0 Transitiona//EN" " <xm runat="server" id="dimensions"> <dimensions> <entities> <entity>1</entity> </entities> <scenarios>a</scenarios> <measures> <measure>output</measure> </measures> <accounts> <account> </account> <account> </account> <account>-</account> <account> </account> <account></account> <account> </account> <account> </account> <account> </account> <account>-</account> <account> </account> <account> </account> <account> </account> <account>-</account> <account> </account> <account></account> <account> </account> <account> </account> <account>-</account> <account> </account> C# in Active Server Pages 43

44 <account></account> <account> </account> <account> </account> <account>-</account> <account> </account> <account> </account> <account>-</account> <account> </account> <account></account> <account> </account> <account></account> <account> </account> <account>=</account> <account></account> <account> </account> <account></account> <account> </account> <account>-</account> <account> </account> <account></account> <account> </account> <account></account> <account></account> </accounts> <time>a</time> </dimensions> </xm> <script runat="server"> protected void Page_Load(object sender, System.EventArgs eventargs string user = Request.Params["user"]; if (user == nu user == "" user = "username"; string password = Request.Params["password"]; if (password == nu password == "" password = "password"; string hsfserver = Request.Params["hsfServer"]; if (hsfserver == nu hsfserver == "" hsfserver = "HSFServer"; string database = Request.Params["database"]; string entity = Request.Params["entity"]; if (entity == nu entity == "" entity = "1"; string scenario = Request.Params["scenario"]; if (scenario == nu scenario == "" scenario = "Base"; string measure = Request.Params["measure"]; if (measure == nu measure == "" measure = "Output"; boo entityopened = fase; string sessionid = ""; HSFEntityWebService.HSFEntityWebService hsfentitywebservice = nu; try // Create genera web service ink. HSFWebService.HSFWebService hsfwebservice = new HSFWebService.HSFWebService(; // Create session with user/password. sessionid = hsfwebservice.createsession(user, password; if (sessionid == "" throw new Exception("Can not create a 44 Sampe Code

45 vaid session."; // Open server. hsfwebservice.openserver(sessionid, hsfserver; // Enum databases and make sure there is at east one. string[] databases = hsfwebservice.enumdatabases(sessionid; if (databases.length < 1 throw new Exception("There are no databases in the current server."; [0]; // Open database. if (database == nu database == "" database = databases hsfwebservice.opendatabase(sessionid, database; // Get a ist of entities. System.Data.DataSet entities = hsfwebservice.enumentities (sessionid, "", "A"; if(entities == nu entities.tabes["entities"] == nu throw new Exception("There are no entities in this database"; System.Data.DataRow[] entityrows = entities.tabes ["Entities"].Seect(; if (entityrows.length < 1 throw new Exception("There are no entities in this database"; entity = (stringentityrows[0]["id"]; // Create entity web service ink. hsfentitywebservice = new HSFEntityWebService.HSFEntityWebService(; // Open entity. hsfentitywebservice.openentity(sessionid, entity, fase; // Mark entity as opened. entityopened = true; // Get ist of time periods. System.Data.DataSet timeperiods = hsfentitywebservice.enumtimeperiods(sessionid; if(timeperiods == nu timeperiods.tabes["timeperiods"] == nu throw new Exception("There are no time periods in this entity"; System.Data.DataRow[] timeperiodrows = timeperiods.tabes ["TimePeriods"].Seect(; if (timeperiodrows.length < 1 throw new Exception("here are no time periods in this entity"; int timecos = timeperiodrows.length; System.Data.DataSet scenarios = hsfentitywebservice.enumscenarios(sessionid; if (scenarios == nu scenarios.tabes["scenarios"] == nu throw new Exception("There are no scenarios in this entity"; System.Data.DataRow[] scenariorows = scenarios.tabes ["Scenarios"].Seect(; if (scenariorows.length < 1 throw new Exception("here are no scenarios in this entity"; C# in Active Server Pages 45

46 System.Data.DataSet accounts = hsfentitywebservice.enumaccounts (sessionid; if (accounts == nu accounts.tabes["accounts"] == nu throw new Exception("There are no accounts in this entity"; System.Data.DataTabe accounttabe = accounts.tabes ["Accounts"]; System.Data.DataRow[] accountrows = accounttabe.seect(; if (accountrows.length < 1 throw new Exception("here are no accounts in this entity"; string[] accountlist = nu; string xm = this.dimensions.innertext; System.Xm.XmDocument xmdoc = new System.Xm.XmDocument(; xmdoc.loadxm(xm; System.Xm.XmNodeList accountnodes = xmdoc.seectnodes ("descendant::dimensions/accounts/account"; if (accountnodes!= nu && accountnodes.count > 0 accountlist = new string[accountnodes.count]; for (int j = 0; j < accountnodes.count; j++ // Get node and create a new data ce info object. System.Xm.XmNode accountnode = accountnodes.item(j; if (accountnode!= nu accountlist[j] = accountnode.innertext; if (accountlist[j] == "" accountlist[j] = " "; System.Data.DataSet datacesout = nu; // Create data set for GetCeData ca. System.Data.DataSet datacesin = new System.Data.DataSet(; System.Data.DataTabe datacesintabe = datacesin.tabes.add ("DataCes"; // Add coumns to the tabe. datacesintabe.coumns.add("entity", typeof(string; datacesintabe.coumns.add("account", typeof(string; datacesintabe.coumns.add("time", typeof(string; datacesintabe.coumns.add("scenario", typeof(string; datacesintabe.coumns.add("measure", typeof(string; datacesintabe.coumns.add("custommembers", typeof(string; (; foreach (string account in accountlist for (int j = 0; j < timecos; j++ System.Data.DataRow datarow = datacesintabe.newrow datarow["entity"] = entity; datarow["account"] = account; datarow["measure"] = measure; datarow["scenario"] = scenario; datarow["time"] = timeperiodrows[j]["id"]; datarow["custommembers"] = ""; 46 Sampe Code

47 datacesintabe.rows.add(datarow; // Ca GetDataCes. datacesout = hsfentitywebservice.getentitydataces (sessionid, datacesin; if (datacesout == nu throw new Exception("DataCes data set not found."; System.Data.DataTabe datacesouttabe = datacesout.tabes ["DataCes"]; if (datacesouttabe == nu throw new Exception("DataCes tabe not found."; // Create tabe. HtmTabe tabe = new HtmTabe(; HtmTabeRow row; HtmTabeCe ce; // Create the top header row. row = new HtmTabeRow(; // Create the first two header ces and add them to the current row. ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe("th"; ce.aign = "center"; ce.innerhtm = "Account Names"; row.ces.add(ce; // Create the time header. int i; for (i = 0; i < timecos; i++ System.Data.DataRow timeperiodrow = timeperiodrows[i]; ce = new HtmTabeCe("th"; ce.innerhtm = (stringtimeperiodrow["name"]; row.ces.add(ce; // Add the row to the tabe. tabe.rows.add(row; 2008"; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "eft"; ce.cospan = 4; ce.innerhtm = "Fie: 1.ac Last Cacuated 9:38:05 PM 6/10/ row.ces.add(ce; ce = new HtmTabeCe(; C# in Active Server Pages 47

48 ce.aign = "right"; ce.cospan = timecos - 3; string scenariolist = "Scenario:<seect name=\"scenariolist\" onchange=\"gotosite(this.options[this.seectedindex].vaue\">"; for (i = 0; i < scenariorows.length; i++ scenariolist += "<option vaue=\"incomestatement.aspx? scenario=" + (stringscenariorows[i]["id"] + "\""; if (scenario == (stringscenariorows[i]["id"] scenariolist += " seected"; scenariolist += ">" + scenariorows[i]["id"] + "</option>"; scenariolist += "</seect>"; ce.innerhtm = scenariolist; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "center"; ce.cospan = timecos + 1; ce.innerhtm = "Income Statement for Sampe Incorporated"; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "center"; ce.cospan = timecos + 1; ce.innerhtm = "Strategic Pan "; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.cospan = timecos + 1; ce.innerhtm = " "; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.innerhtm = "Author: Hyperion Soutions"; row.ces.add(ce; ce = new HtmTabeCe(; 48 Sampe Code

49 ce.aign = "eft"; ce.cospan = timecos; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.innerhtm = "SIC Code: 4800"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "eft"; ce.cospan = timecos; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.innerhtm = "Scenario: Base"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "eft"; ce.cospan = timecos; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.innerhtm = "Miions of Doars"; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "eft"; ce.cospan = timecos; row.ces.add(ce; tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.cospan = timecos + 1; ce.innerhtm = " "; row.ces.add(ce; tabe.rows.add(row; // Create the top header row. row = new HtmTabeRow(; C# in Active Server Pages 49

50 // Create the first two header ces and add them to the current row. ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe("td"; row.ces.add(ce; // Create the time ces. for (i = 0; i < timecos; i++ System.Data.DataRow timeperiodrow = timeperiodrows[i]; ce = new HtmTabeCe(; ce.aign = "center"; ce.innerhtm = (stringtimeperiodrow["name"]; row.ces.add(ce; // Add the row to the tabe. tabe.rows.add(row; // Create the next header row and add it to the tabe; row = new HtmTabeRow(; ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.cospan = timecos + 1; ce.innerhtm = " "; row.ces.add(ce; tabe.rows.add(row; foreach (string account in accountlist // Create the account row. row = new HtmTabeRow(; if (account == "-" ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; row.ces.add(ce; for (i = 0; i < timecos; i++ ce = new HtmTabeCe(; ce.innerhtm = "<hr />"; row.ces.add(ce; ese if (account == "=" ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; row.ces.add(ce; for (i = 0; i < timecos; i++ 50 Sampe Code

51 "'"; ce = new HtmTabeCe(; ce.innerhtm = "======"; row.ces.add(ce; ese if (account == " " ce = new HtmTabeCe("th"; row.ces.add(ce; ce = new HtmTabeCe(; ce.cospan = timecos + 1; ce.innerhtm = " "; row.ces.add(ce; ese ce = new HtmTabeCe("th"; ce.aign = "eft"; ce.innerhtm = account; row.ces.add(ce; ce = new HtmTabeCe(; ce.aign = "eft"; accountrows = accounttabe.seect("id='" + account + if (accountrows.length > 0 ce.innerhtm = (stringaccountrows[0]["name"]; row.ces.add(ce; for (int j = 0; j < timecos; j++ ce = new HtmTabeCe(; ce.aign = "right"; try System.Data.DataRow[] vauerows = datacesouttabe.seect("account='" + account + "' AND Time='" + timeperiodrows[j]["id"] + "'"; if (vauerows.length > 0 Doube d = Doube.Parse((stringvaueRows[0] ["Vaue"] / ; ce.innerhtm = d.tostring("n2"; ese ce.innerhtm = "N/A"; catch (Exception ce.innerhtm = "N/A"; row.ces.add(ce; C# in Active Server Pages 51

52 tabe.rows.add(row; // Add the tabe to the page. this.contros.add(tabe; catch (Exception e Response.Write("<center><h3>" + e.message + "</h3></center>"; try if (hsfentitywebservice!= nu && entity!= nu && entity!= "" && entityopened hsfentitywebservice.reeaseentitylock(sessionid, entity; catch (Exception e </script> <script anguage="javascript"> function gotosite(site if(site!= "" sef.ocation=site; </script> <htm xmns=" > <head id="head1" runat="server"> <tite>income Statement</tite> <stye type="text/css"> th coor: white; background-coor: darkgray tabe font-size: 90%; </stye> </head> <body> </body> </htm> 52 Sampe Code

Readme ORACLE HYPERION PROFITABILITY AND COST MANAGEMENT

Readme ORACLE HYPERION PROFITABILITY AND COST MANAGEMENT ORACLE HYPERION PROFITABILITY AND COST MANAGEMENT Reease 11.1.2.4.000 Readme CONTENTS IN BRIEF Purpose... 2 New Features in This Reease... 2 Instaation Information... 2 Supported Patforms... 2 Supported