hfm api deep dive – making a better financial management client
DESCRIPTION
While the Financial Management Client program that ships with HFM provides key functionality is quite reliable, there are many areas where it could be improved. Fortunately for us, the Financial Management Client is a great example of a program that implements the HFM COM API as many of the program’s features are directly attributable to API functions. Due to this fact, we can focus on adding value without having to completely reinvent the wheel. This session, which builds off of a previous API presentation, will further walk you through a complete program build utilizing HFM COM API functionality and Microsoft Visual Studio .NET. Fully working code will be provided as well for viewers.TRANSCRIPT
![Page 1: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/1.jpg)
HFM API Deep Dive Making a Better Financial Management Client
Charles Beyer
![Page 2: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/2.jpg)
Build a “complete” .NET App for HFM API● “Brief” HFM API Overview● Prepare a Development Environment● Coding your own HFM Client App● Improving on Client App● Tips, Tricks, and Warnings
3rd Party Tools / Projects Q & A
Session Objectives / TOC
![Page 3: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/3.jpg)
Code Samples will be made available To expedite certain areas, we will utilize screen
shots while doing live demos in others Slides / Demos should be sufficient to do work
offline in case we bump into time issues Please leave feedback!
Additional Notes
![Page 4: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/4.jpg)
Computer & Technology ‘Nerd’ – Started with a Apple II and TRS-80. Haven’t looked back.
16+ years professional software experience, created and sold commercial software.
7 years working with Hyperion products.
Love to help out, feel free to ask and I’ll help if time permits!
About the Speaker
![Page 5: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/5.jpg)
“Brief” HFM API Overview
![Page 6: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/6.jpg)
Three Main APIs● COM [Primary Focus for Session]
● Updated for 11.1.2.2 for expanded dimensionality● Extended Analytics HTTP Listener
● Web Object Model [ADF Webinar – TBD]● 11.1.2.1 and prior : Components Utilized via ASP pages● 11.1.2.2+ : Java/J2EE implemented with Oracle ADF
Framework
● FM Web Service [TBD]● Optional, now required, component first utilized by
Financial Close Management● Behind the scenes is really the COM library.
Brief HFM API Overview
![Page 7: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/7.jpg)
Brief HFM API Overview [COM]Web Object Model Features COM Object Model FeaturesLog On / Log Off Log On / Log OffOpen FM Applications Open FM ApplicationsRegister / Unregister Clusters/App Servers Register / Unregister Clusters/App ServersGetting Dimension Attributes Get Metadata AttributesGet / Set Line Item Details Get / Set Line Item DetailsProcess Management Interaction Process Management InteractionOpen / Close Periods Open / Close PeriodsJournals (Create, Delete, Submit, Post, etc.) Process JournalsUser Security (Rights / User Lists) User Security (Rights / User Lists)Document Management (Forms / Grids) Get / Set data for arrays of cells
POV SettingsExecuting consolidations, translations, calculations
Audit Information (Task, Data, etc.)
Load/Extract member lists, metadata, rules, data,and journals
Server Information/Control (Logoff Users, Enable/Disable Connections) Extended Analytics
ActiveX control for dimension members selection
![Page 8: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/8.jpg)
Brief HFM API Overview [COM]
Type File Functionality
HfmSliceCOM Support for Configurable Dimensionality
HsxClient Logon/Logoff, Open/Create/Delete Applications
HsxClientUI User Interface for Logon/off, Open/Create/Delete Applications
HsxServer App Server info : Application Names, DSNs
HsvSession Parent Obect to Metadata & Data, Session Related Info
HsvMetadata Metadata Related Functions
HsvData Sets and Gets data in cells
HsvCalculate Executes consolidations, translations, and calculations
HsvJournals Manage periods, create journals and templates, process journals
HsvSecurityAccess Get/Set Application’s users, roles, and security class access.
![Page 9: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/9.jpg)
Brief HFM API Overview [COM]
Type Library Functionality
HsvSystemInfo System Items (Get/Set App Name, Server Name)
HsvProcessFlow Process Management
HsvReports System Reports
HsvICM Intercompany
HsvMDArrays Statutory / IC Transactions Data
HsvDataCubes Data Access @ Sub Cube Level
HsvDQI “Intelligent” Data Retrieval
HsvStarSchemaACM Extended Analytics
HsvSecurityLoadACV Security Loading and Extracting
HsvMetadataLoadACV Metadata Loading and Extracting
HsvRulesLoadACV Rules Load and Extracting
![Page 10: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/10.jpg)
Brief HFM API Overview [COM]
Type Library Functionality
HsvcDataLoad Data Loading and Extracting
HsvJournalACV Journal Loading and Extract, Journal Template loading
HsvPOVSelection ActiveX display option for selecting POV
HsvResourceManager Manages Error Messages
HFMConstants Constants used by API calls throughout
![Page 11: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/11.jpg)
Brief HFM API Overview [HTTP Listener]
URL: http://<web server>/hfm/EIE/EIEListener.asp?
app_name=<HFMAppName>&action=launch_EA_extract Include following data in header
● SSO Token● Content Type : text/xml
HTTP Request Stream Parameters● Application Name● Extract Type● Push Options
![Page 12: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/12.jpg)
Brief HFM API Overview [HTTP Listener]
HTTP Request Stream Parameters (cont)● DSN● Prefix● ExcludeDynamicAccounts● Scenario(s)● Year(s)● Period(s)● View(s)● Entity(ies)
![Page 13: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/13.jpg)
Brief HFM API Overview [HTTP Listener]
HTTP Request Stream Parameters (cont)● Entity(ies)● Value(s)● Account(s)● ICP(s)● Custom1(s)● Custom2(s)● Custom3(s)● Custom4(s)
XML Response Message returned
![Page 14: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/14.jpg)
Prepare a Development Environment
![Page 15: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/15.jpg)
Requirements [COM]● HFM Client Installed● Server Files Available
● Copied Locally● Read only access to files on remote location (i.e. server)
● Microsoft Visual Studio● Deployment / Installer Notes
Prepare a Development Environment
![Page 16: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/16.jpg)
Create Installer (Required Assemblies, 11.1.2.x)● commonComponents● productCommonComponents● hfm_client● hfm_common
Launchtool.cmd to start installation process Select choose individual components
● Financial Management: Client, ADM Configure Cluster / Services / DCOM Start Client and perform test connection
Install HFM Client (11.1.2.x)
![Page 17: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/17.jpg)
Server Files Default Location● <EPM_HOME>\products\FinancialManagement\
Server● <EPM_HOME> = C:\Oracle\Middleware\EPMSystem11R1\
System11R1
Copy them local or Reference them direct from server.● If referencing, be sure to include in your app’s
installer so that they copy!
Locate (and Copy) Server Files
![Page 18: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/18.jpg)
Express 2012 for Windows Desktops● http://www.microsoft.com/visualstudio/eng#products/
visual-studio-express-for-windows-desktop+product-express-desktop
Requirements● O/S : Win7 SP1, Win 8, Server 2008, Server 2012● Hardware : 1Ghz CPU, 1GB RAM, 5GB Disk, DX9
NOTES: ● Links change semi-frequently so Google Visual
Studio Express and you won’t go wrong.● As new versions are released old versions are
retired.
Visual Studio (2012)
![Page 19: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/19.jpg)
Installation● Click the Download button on website● Use default settings for file locations, etc.● When it comes to installing option components, I
generally install them.● MSDN Document Library is up to you.
If you don’t meet requirements for 2012● 2010 ISO :
http://download.microsoft.com/download/1/E/5/1E5F1C0A-0D5B-426A-A603-1798B951DDAE/VS2010Express1.iso
● 2008 ISO : Retired, though on torrents*
Visual Studio (2012)
![Page 20: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/20.jpg)
HFM Client App
![Page 21: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/21.jpg)
Open / Close Applications, Logoff Explore Data, User Preferences, Database
Management Setup / Process Journals Define App Profile, Create/Delete App, Manage
Metadata Load Security, Metadata, Member Lists, Rules,
Data, Journals
HFM Client App Functionality
![Page 22: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/22.jpg)
Coding Your Own Client App
![Page 23: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/23.jpg)
Visual Studio Project Creation Adding References to Files Recreate Existing Functionality
● Authentication [Demo]● Opening / Closing Apps [Demo]● Extracting Metadata, Rules, Data [Demo]
Coding Your Own Client App
![Page 24: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/24.jpg)
Create Visual Studio Project
![Page 25: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/25.jpg)
Adding References
![Page 26: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/26.jpg)
Shared Objects
![Page 27: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/27.jpg)
Authentication [Demo]
![Page 28: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/28.jpg)
Opening Application [Demo]
![Page 29: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/29.jpg)
Logoff [Demo]
![Page 30: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/30.jpg)
Extract Metadata [Demo]
Add References Create Standalone Form Wire up Buttons : File Browser, View (Notepad),
Check All, Uncheck All, Extract Implement API Extract Logic for Metadata
![Page 31: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/31.jpg)
Extract Metadata - References
![Page 32: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/32.jpg)
Extract Metadata – Create Form
![Page 33: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/33.jpg)
Extract Metadata – Wire Buttons
![Page 34: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/34.jpg)
Extract Metadata – Wire Buttons
![Page 35: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/35.jpg)
Extract Metadata – Wire Buttons
![Page 36: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/36.jpg)
Extract Metadata – API Logic
![Page 37: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/37.jpg)
Extract Metadata – API Logic
![Page 38: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/38.jpg)
Extract Metadata – API Logic
![Page 39: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/39.jpg)
Extract Metadata – API Logic
![Page 40: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/40.jpg)
Improving on the Client App
![Page 41: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/41.jpg)
App Title / Statusbar Updates [Demo] Dynamic Menu [Demo] Admin / System Info [Demo] Smarter Metadata / Rules Extracting/Loading
[Demo]
Improving on the Client App
![Page 42: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/42.jpg)
App Title / Statusbar Updates [Demo]
![Page 43: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/43.jpg)
App Title / Statusbar Updates [Demo]
![Page 44: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/44.jpg)
Menu Control [Demo]
![Page 45: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/45.jpg)
Menu Control [Demo]
![Page 46: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/46.jpg)
Menu Control [Demo]
![Page 47: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/47.jpg)
System Info [Demo]
![Page 48: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/48.jpg)
System Info [Demo]
![Page 49: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/49.jpg)
Tips, Tricks, and Warnings
![Page 50: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/50.jpg)
Be sure to work in Dev first! ● Some API calls could cause trouble if used
incorrectly!● Easier to Debug ● Can Run Additional Debug/Performance Tools
Start small and test frequently Use Debug functionality to step through code Trap exceptions to handle errors gracefully! Create Installer for your finished product
Tips, Tricks, and Warnings
![Page 51: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/51.jpg)
COM API Doc & Samples● http://docs.oracle.com/cd/E17236_01/epm.1112/hfm
_developer_11.1.2.2.300.pdf● SDK via e-delivery for additional code samples
Web API Doc & Samples● Web API
● Pre-11.1.2.2 : http://docs.oracle.com/cd/E17236_01/epm.1112/hfm_websdk.pdf
● 11.1.2.2+ : http://docs.oracle.com/cd/E17236_01/epm.1112/hfm_custom_pages_development.pdf
Tips, Tricks, and Warnings
![Page 52: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/52.jpg)
Web Service● No Docs Yet!● Access ASMX pages in browser to view information!
[http://<your web server>/hfmapplicationservice/] Utilize existing resources for help!
● Oracle Forum (http://forums.oracle.com)● Blogs
● Mine (new) : http://www.charlescbeyer.com● Finnish Hyperion Guy : http://hyperionfinn.blogspot.com/● SlideShare / Google : Tons of Info is out there.
Tips, Tricks, and Warnings
![Page 53: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/53.jpg)
Web Service isn’t officially published● May go away at any time?
Great Training Material for Learning .NET● http://www.microsoftvirtualacademy.com/● http://msdn.microsoft.com/en-US/vstudio/cc136611
Tips, Tricks, and Warnings
![Page 54: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/54.jpg)
3rd Party Tools / Projects
![Page 55: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/55.jpg)
HFM Batch & hfmCMD by Adam Gardiner● C# Command Line Implementations of API
functionality. ● Batch : https://github.com/agardiner/hfm-batch● hfmCMD : https://github.com/agardiner/hfmcmd
EPM Maestro : http://epmmaestro.com/ Accelatis : http://www.accelatis.com/ Star Analytics :
http://staranalytics.com/products/
3rd Party Tools / Projects
![Page 56: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/56.jpg)
Charles [email protected]
Glenview, IL
USA
+1.847.275.6317
Questions?
Bloghttp://www.charlescbeyer.com
LinkedInhttp://www.linkedin.com/in/charlesbeyer
https://twitter.com/beyerch
Oracle Forums
beyerch2
![Page 57: HFM API Deep Dive – Making a Better Financial Management Client](https://reader033.vdocument.in/reader033/viewer/2022061222/54c0e7804a79597c568b4596/html5/thumbnails/57.jpg)
Source Codehttp://www.charlescbeyer.com/Kscope/HFM_Client_V2.zip