KSCOPE 2015 - Improving Reliability, Rollouts, Upgrades/Migrations
•Download as PPTX, PDF•
1 like•1,153 views
This document discusses improving Smart View documents through VBA and the Smart View API, simplifying Smart View deployments, and converting workbooks from the Essbase Add-In to Smart View. It covers using VBA to add logic for performance optimizations, input validation, add-in detection, and broken link detection. The Smart View API is demonstrated for refreshing data, managing connections, and creating private connections. Methods for deploying Smart View through silent installation and pushing default options via the registry are presented. A utility for converting Essbase Add-In workbooks is demonstrated.
Report
Share
More Related Content
What's hot
What's hot (17)
Viewers also liked
Viewers also liked (20)
Similar to KSCOPE 2015 - Improving Reliability, Rollouts, Upgrades/Migrations
Similar to KSCOPE 2015 - Improving Reliability, Rollouts, Upgrades/Migrations (20)
Recently uploaded
Recently uploaded (20)
KSCOPE 2015 - Improving Reliability, Rollouts, Upgrades/Migrations
- 2. Smart View Improving Upgrades/Migrations, Rollouts, and Reliability. Charles Beyer Huron Consulting Group
- 3. About Huron
- 4. About Huron
- 5. 17 years professional experience in software development, infrastructure, and consulting. ● 9 years working with Oracle/Hyperion products Published both Open Source and Commercial software products. Always happy to help out with questions (time permitting of course!) Contributes on blogs and OTN Discussion Boards (beyerch2) About the Speaker
- 6. Improve robustness of Smart View documents ● Proactive Add-In Verification ● Proactive Connection Monitoring Simplify Deployment / Initial Configuration ● Automate Installation ● Push Default Preferences ● Push Shared Connection Ease conversion from Essbase Add-In Session Goals
- 7. This session will cover the following topics related to Smart View ● Improving Smart View Documents w/ VBA & API ● Simplifying Deployments of Smart View ● Essbase Add-In Conversion Topics Covered
- 8. Sample Excel Documents / VBA is provided at the end of the PowerPoint! To expedite the session (and minimize Murphy’s Law), session is combination of off- line / on-line demonstrations Probably more material than session time, so be sure to review deck later Please leave feedback, good or bad. All constructive feedback helps to improve presentations and is welcome! Before We Begin….
- 9. Improving Smart View Documents with VBA & Smart View API Smart View
- 10. VBA Overview ● What is VBA? ● Excel Model / Events / Methods ● Code Editor ● Developer Menu / Design Mode / Wiring Events VBA – Topics Covered
- 11. Performance Optimizations ● Screen Updating ● Enable Events ● Calculation Mode VBA – Topics Covered (continued)
- 12. Examples ● Performance Demonstration ● Invalid Cell Identification ● Add-In Presence Detection ● Add-In Status Detection (Enabled/Disabled/Re- Enable) ● Broken Link Detection / Correction VBA Topics Covered (continued)
- 14. Visual Basic for Applications is a derivative of the Microsoft Visual Basic language that enables programmatic interaction with Microsoft Office products. This allows for custom logic to be added to your Office documents. (You can even leverage this outside of Office to perform work against Office products) What is VBA?
- 15. Excel Object Model – This model exposes the key parts of an Excel document to VBA. The following objects are typically used when working with Excel in VBA: ● Application – Items that are Excel application related. ● Workbook – Items that are related to a workbook ● Worksheet – Items related to a worksheet ● Range – Reference to one or more cells Excel Model / Events / Methods
- 16. Application Object Example Excel Model (continued)
- 17. Workbook Object Example Excel Model (continued)
- 18. Worksheet Object Example Excel Model (continued)
- 19. Range Object Example Excel Model (continued)
- 20. Methods – Code Subroutines related to an object that perform actions. ● ActiveWorkbook.Close – Starts a routine to close the document. Properties – Items related to objects that set/return variables. ● Application.Name – Reads the name of application Excel Methods & Properties (continued)
- 21. Events – VBA code is typically executed when something happens. There are many prebuilt event “traps”, typical events are: ● Open – Triggers when the application or a workbook is first opened. ● Activate – Triggers when a workbook or worksheet gets “focus” Excel Events (continued)
- 22. Events – VBA code is typically executed when something happens. There are many prebuilt event “traps”, typical events are: ● BefSave / BefClose – Triggers before a workbook is Saved or Closed. ● SheetChange / Change – Triggers when a change is detected on a worksheet / Cell Excel Events (continued)
- 23. Workbook Open Event Example Excel Events (continued)
- 24. Worksheet Activate Event Example Excel Events (continued)
- 25. Workbook BefSave Event Example Excel Events (continued)
- 26. SheetChange Event Example Excel Events (continued)
- 27. Code Editor – This is the user interface that enables the user to create VBA for their Workbook. There are a few key pieces: ● Project Window – This provides a listing of all VBA projects for the currently open workbooks ● Properties Window – This provides an interface to update properties for Workbooks / Worksheets ● Code Editor Window – This is where VBA can be edited ● Immediate / Debug Window – Used during design time to debug code. Excel Code Editor
- 28. Excel Code Editor (continued)
- 29. Notes: ● To start the code editor, press ALT-F11from Excel. ● To create code for a Worksheet / Workbook, double click on it in the Project Window. ● To create code for a specific Method/Event, use the drop down menus at the top of the Code Editor portion of the screen. Excel Code Editor (continued)
- 30. Developer Menu – Excel toolbar consisting of app dev purposes Design Mode – Special mode in Excel for performing form edits . Event Wiring – Process of hooking up a form item with code execution (e.g. Button press) Developer Menu / Design Mode / Wiring Events
- 31. To enable: Excel Options, then Customize Ribbon, then check Developer Main Tab Developer Menu (continued)
- 32. Notable Items: ● Insert – This allows us to add controls (e.g. Button) to worksheets ● Design Mode – Allows editing of controls without events ● View Code – Takes you to source editing window Developer Menu (continued)
- 33. Notable Items: ● Insert – This allows us to add controls (e.g. Button) to worksheets ● Design Mode – Allows editing of controls without events ● View Code – Takes you to source editing window Developer Menu (continued)
- 34. Design Mode / Event Wiring DEMO [1_Planning_CellNote_Editor_v1.xlsm]
- 35. Performance Optimizations VBA Performance Optimizations
- 36. A few settings can make a huge difference ● Screen Updating ● Enable Events ● Calculation Mode Performance Optimizations
- 37. There are advantages and disadvantages to Disabling Screen Updating: Advantages: ● Unneeded screen activity confuses end users ● Significant Performance Improvement Disadvantages: ● Don’t forget to turn it back on! Performance – Screen Updating
- 38. Controlling Screen Updating is straightforward: Disable Enable Performance – Screen Updating (continued)
- 39. Enabling / Disabling Events has advantages and disadvantages: Advantages: ● Prevents unnecessary events from firing ● Significant Performance Improvement Disadvantages: ● Don’t forget to turn it back on! Performance – Events
- 40. Controlling Events is straightforward: Disable Enable Performance – Events (continued)
- 41. Changing the Calculation Mode from Automatic to Manual will prevent calculations from occurring in the middle of a process. The calculations will still occur when set to Automatic or when manually started. Doing this has the following advantages and disadvantages: Advantages: ● Prevents unnecessary calculations from occurring ● Significant Performance Improvement Disadvantages: ● Don’t forget to set back to Automatic! Performance – Calculation Mode
- 42. Changing the Calculation Mode is straightforward: Manual Automatic Performance – Calculation Mode (continued)
- 46. Add-In Detection (continued) When Present and “Installed”
- 47. Add-In Detection (continued) Takeaways ● If HsTbar.xla is not shown as Installed, Smart View isn’t functioning and it needs to be “Installed”, this can be done automatically for the end user. ● If HsTbar.xla doesn’t show up in the list of Add-Ins, Smart View has not been installed. ● Disabled Items is stored in Registry and is fixed in example. ● Including some detection in the Load method of the Workbook would solve a lot of end user surprises. ● Excel needs to be restarted after re-enabling, though you can communicate this to user easily.
- 48. HsTbar Broken Link DEMO [5_HsTbar_Broken_Links.xlsm] Typical Causes ● User does not have Smart View ● Creator of document had Smart View installed to a different file path.
- 49. VBA Demo Summary How can we now improve our documents? Leverage Workbook Open Method To ● Disabled / “Uninstalled” Smart View ● Check for Broken Links Leverage Save Method ● Check for non-Refreshed Data / Non-Numeric Improve Performance before large queries ● ScreenUpdating, Calculation Mode, etc.
- 50. Smart View API Smart View
- 51. Common API Calls ● Menu Functions ● HypMenuVRefresh ● HypMenuVRefreshAll ● Connection Functions ● HypConnect / HypConnected / HypConnectionExists ● HypCreateConnectionEx ● HypDisconnect / HypDisconnectAll / HypDisconnectEx ● HypGetSetSharedConnections / HypSetSharedConnectionsURL Smart View API – Topics Covered
- 52. “Menu Functions” – Menu functions expose the functionality found on the Smart View ribbon. ● HypMenuVRefresh – Refreshes the active worksheet. ● HypMenuVRefreshAll – Refreshes all worksheets Smart View API – Menu Functions
- 53. How could we leverage previous VBA Events and these functions in our workbooks? Smart View API – Menu Functions (continued) ● Workbook BeforeSave? ● Before Saving your book, what if you ensured all data was refreshed?“Menu Functions” – Menu functions expose the functionality found on the Smart View ribbon.
- 54. Connection Functions – Functions that deal with connection to Smart View Providers ● HypConnect – Establishes a connection ● HypConnected – Checks if a defined connection has been established ● HypConnectionExists – Checks to see if a connection exists ● HypCreateConnectionEx – Creates a connection Smart View API – Connection Functions
- 55. Connection Functions – Functions that deal with connection to Smart View Providers ● HypDisconnect/Ex – Disconnects the connections on the Active Worksheet ● HypDisconnectAll – Disconnects connections on all worksheets in this workbook ● HypGetSetSharedConnections / HypSetSharedConnectionsURL – Retrieves / Sets the Shared Connection URL Smart View API – Connection Functions (continued)
- 56. How could we leverage previous VBA Events and these functions in our workbooks? Smart View API – Connection Functions (continued) ● Workbook Open? ● Check List of Expected Connections ● Warn / Create Missing Connections ● Workbook Open / Worksheet Activate? ● Check Connection Status ● Auto Connect w/User Prompt or Push stored credentials
- 58. Smart View API More Info? Smart View Developer’s Guide (sv_developer.pdf)
- 60. Three key areas ● Smart View EXE Installation – How and Who performs the install? ● Default Options – What are the must have settings and how to apply them? ● Smart View Connections – What connections are needed and how to create? Simplifying Deployments (continued)
- 61. Smart View Install – The most efficient (and user friendly) way to install Smart View is via Silent Install ● SmartView.exe /s – Installs Smart View quietly to default folder ● SmartView.exe /s /v” INSTALLDIR=C:YourDir” – Installs Smart View quietly to a directory of your choosing. Smart View Install
- 62. Smart View Install Notes ● UAC does not matter when installed as a System User (e.g. installed via deployment tool) ● Installing as a System User makes Smart View available at the machine level ● Non-Admin users can install directly; however, SV only available to them. Smart View Install (continued)
- 63. Default Options – Default Options refer to the user configurable preferences for Smart View. These preferences are generally set via the Smart View Options menu. ● Fresh installs do not necessarily give you defaults that you want (e.g. #MISSING instead of #NUMERICZERO) Default Options
- 64. Default Option Notes ● As of 11.1.2.1.102 – Smart View no longer uses Global Default settings. Settings are stored on a per worksheet basis. ● Default Options (used for new worksheets) are stored in the windows registry (*few exceptions) ComputerHKEY_CURRENT_USERSoftwareHyperion SolutionsHyperionSmartViewOptionsCAOptionsXML Default Options (continued)
- 65. The following items can be set ● Member Options ● General: Zoom In Level, Member Name Display, Indentation, Ancestor Position ● Member Retention: Include Selection, Within Selected Group, Remove Unselected Groups ● Comments and Formulas: Preserve Formulas and Comments, in ad hoc operations (except pivot), Formula Fill, Enable Enhanced Comment Handling, Preserve Formula on POV Change Default Options (continued)
- 66. The following items can be set ● Data Options ● Suppress Rows: No Data/Missing, Zero, No Access, Invalid, Underscore Characters, Repeated Members ● Suppress Columns: No Data/Missing, Zero, No Access ● Replacement: #NoData/Missing Label, #NoAccess Label, #Invalid/Meaningless, Submit Zero, Display Invalid Data, Enable Essbase Format String ● Mode: Cell Display, Navigate without Data, Suppress Missing Blocks Default Options (continued)
- 67. The following items can be set ● Formatting ● Use Thousands Separator, Use Cell Styles, Use Excel Formatting, Retain Numeric Formatting, Adjust Column Width, Scale, Preview, Decimal Places, Preview, Repeat Member Labels ● Cell Styles ● *** Technically not supported; however, settings contained in the Registry Key [ComputerHKEY_CURRENT_USERSoftwareHyperion SoftwareHyperionSmartViewOptionsCellStyles] *** Default Options (continued)
- 68. The following items can be set ● Advanced ● General: Shared Connections URL*, Number of Undo Actions, Number of Most Recently Used Items ● Logging: Log Message Display, Route Messages to File, Clear Log File on Next Launch ● Display: Language, Display Smart View Shortcut Menu Only, Disable Smart View in Outlook**, Enable Ribbon Context Changing, Display options that are not valid for the active connection, Display Drill-Through Report Tool- Tips, Show Progress Information After (seconds), Progress Time Delay Default Options (continued)
- 69. The following items can be set ● Advanced ● Compatibility: Reduce File Size***, Improve Metadata Storage****, Refresh Selected Functions and their dependents ● Mode: Use Double-click for Operations Default Options (continued)
- 70. * - Contained in properties.xml Win 7 – C:Users<user account>AppDataRoaming|LocalOracleSmartView XP - C:Documents and Settings<user account>Application DataOracleSmartViewproperties.xml ** - Contained in Registry Key [ComputerHKEY_CURRENT_USERSoftwareHyperion SoftwareHyperionSmartViewPreferencesOutlookDisabled ] *** - Contained in Registry Key [ComputerHKEY_CURRENT_USERSoftwareHyperion SoftwareHyperionSmartViewPreferencesUseStorageCompression & SelectedOptionTab ] **** - Contained in Registry Key [ComputerHKEY_CURRENT_USERSoftwareHyperion SoftwareHyperionSmartViewPreferencesIgnoreShapes] ***** - Registry Keys contained in hive: Key [ComputerHKEY_CURRENT_USERSoftwareOracleSmartViewextensions] Default Options (continued)
- 71. How to automate? ● Decide what Default Options you want ● Create a Registry file that contains the preferences ● Create a logon / deployment script that executes for each user to apply the registry settings ● Settings are PER USER, not per machine! Default Options (continued)
- 72. Default Options (continued) Sample Registry File
- 73. Default Options (continued) Important Note! If you are pushing updates to the registry, push Timeouts as well!
- 74. Essbase Add-In Conversion Smart View
- 75. ● Key Areas to Consider when migrating/upgrading ● What about existing default settings? ● Converting to Smart View equivalents ● Automation Scripting Essbase Add-In Conversion
- 76. Essbase Workbook Conversion Utility DEMO [9_EssAdd-In SmartView Option Translation Mapping.xlsx]
- 77. Essbase Workbook Conversion Utility DEMO [7_Essbase_AddIn_Workbook Conversion Utility.xlsm]
- 78. Essbase Workbook Conversion Utility DEMO [8_ExtractEssbaseRegistry.vbs]
- 80. Demo Files
- 81. Charles Beyer – Huron Consulting Group ● Email – cbeyer@huronconsultinggroup.com ● Blog – http://charlescbeyer.com/ccb_wp/ Contact Me