EPMofc 10 User En

EPM Add-in for Microsoft Office User Guide ■ SAP BusinessObjects EPM solutions, add-in for Microsoft Office10.0 2013-09-04 Copyright © 2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices. 2013-09-04 Contents Chapter 1 What's New...........................................................................................................................15 What's New in Support Package 15 ......................................................................................15 What's New in Support Package 14 Documentation Patch 03...............................................16 What's New in Support Package 14 Documentation Patch 02 ..............................................16 What's New in Support Package 14 Documentation Patch 01...............................................17 What's New in Support Package 14 Documentation .............................................................19 What's New in Support Package 13 Patch 02 Documentation ..............................................20 What's New in Support Package 13 Documentation..............................................................21 Introduction to the EPM Add-in.............................................................................................23 1.1 1.2 1.3 1.4 1.5 1.6 1.7 Chapter 2 Chapter 3 Installation and Update.........................................................................................................25 Installation..............................................................................................................................25 Update...................................................................................................................................25 Re-activating the EPM Add-In ................................................................................................26 Logon and Connections........................................................................................................27 Logging On and Off................................................................................................................27 Connection Management.......................................................................................................28 Active Connection for the Current Sheet...............................................................................28 Types of Connections............................................................................................................29 Selecting Connections...........................................................................................................30 Selectively connecting or disconnecting sheet/connection pairs ...........................................31 Large Volume Data Sources.................................................................................................33 Restrictions on Specific Features ..........................................................................................33 Drill-Through..........................................................................................................................35 About the EPM add-in Interface............................................................................................39 Main Interface Areas..............................................................................................................39 Performing Actions without the Mouse..................................................................................40 3.1 3.2 3.3 Chapter 4 4.1 4.2 4.3 4.4 4.5 4.6 Chapter 5 5.1 5.2 Chapter 6 6.1 6.2 3 2013-09-04 Contents 6.3 Chapter 7 Using Microsoft Office 2003..................................................................................................40 Features Available.................................................................................................................43 Chapter 8 Security on Members............................................................................................................45 Chapter 9 Open and Save a File............................................................................................................47 Open a Report when Dimensions or Members have Changed...............................................47 Open a File from a Web Portal ..............................................................................................48 Open and Save a File for Planning and Consolidation.............................................................49 Open and Save Connection ..................................................................................................49 Open Actions.........................................................................................................................50 Save Actions..........................................................................................................................51 Open and Save Dialog Box Description and Actions .............................................................52 Server Folder Structure..........................................................................................................52 Context..................................................................................................................................55 Context Favorites...................................................................................................................56 Context Display Options........................................................................................................57 Report Layout Rules..............................................................................................................59 Overall Layout Rules .............................................................................................................59 Basic Layout Rules................................................................................................................60 Dimension Layout Restrictions...............................................................................................61 Page Axis...............................................................................................................................62 Row Axis................................................................................................................................62 Simple Row Axis....................................................................................................................63 Multidimensional or Nested Row Axis....................................................................................63 Asymmetric Row Axis............................................................................................................65 Row Axis Restrictions............................................................................................................66 Column Axis...........................................................................................................................67 Simple Column Axis...............................................................................................................68 Multidimensional or Nested Column Axis ..............................................................................68 Asymmetric Column Axis ......................................................................................................69 Column Axis Restrictions ......................................................................................................70 Data Grid Considerations.......................................................................................................70 Data Grid Important Tips........................................................................................................72 9.1 9.2 9.3 9.3.1 9.3.2 9.3.3 9.3.4 9.3.5 Chapter 10 10.1 10.2 Chapter 11 11.1 11.1.1 11.1.2 11.2 11.3 11.3.1 11.3.2 11.3.3 11.3.4 11.4 11.4.1 11.4.2 11.4.3 11.4.4 11.5 11.5.1 4 2013-09-04 Contents Chapter 12 Report Creation ....................................................................................................................73 Member Identification and Properties.....................................................................................73 Member Identification.............................................................................................................73 Member Properties................................................................................................................74 Report Creation using the EPM Pane.....................................................................................74 Report Creation using the Report Editor.................................................................................76 Report Editor's Layout Tab Presentation................................................................................77 Dimension Placement in the Report Editor.............................................................................78 Member Selection in the Report Editor...................................................................................79 Position of each Dimension in the Page Axis using the Report Editor.....................................80 Report Move in the Sheet using the Report Editor.................................................................80 Shift Insertion Between the Data Grid of the Report and its Row and Column Axis................80 Report Creation Directly in a Sheet........................................................................................81 Member Recognition..............................................................................................................81 Member Entry Using the Member Selector............................................................................85 Member Entry Using the Member Selector (on Large Volume Data Sources)........................95 Member Entry Using the Insert Members Dialog Box.............................................................97 Report Creation using Copy/Paste........................................................................................98 Asymmetric Report Creation...............................................................................................101 12.1 12.1.1 12.1.2 12.2 12.3 12.3.1 12.3.2 12.3.3 12.3.4 12.3.5 12.3.6 12.4 12.4.1 12.4.2 12.4.3 12.4.4 12.5 Chapter 13 Chapter 14 Ownership-based Hierarchies.............................................................................................103 Chapter 15 Time-Dependent Hierarchies..............................................................................................105 Chapter 16 Actions and Options Specific to the Current Report...........................................................107 Report Options....................................................................................................................107 Freeze Data Refresh............................................................................................................108 Display only Base Level Data...............................................................................................108 Do not Store Connection and Do not Store Environment in the Connection.........................108 Data Sorting, Ranking and Filtering .....................................................................................109 Data Sorting ........................................................................................................................109 Data Filtering .......................................................................................................................111 Data Ranking.......................................................................................................................113 Read-only Data....................................................................................................................114 Local Members....................................................................................................................114 Local Member Automatically Detected.................................................................................116 Local Member Creation........................................................................................................117 16.1 16.1.1 16.1.2 16.1.3 16.2 16.2.1 16.2.2 16.2.3 16.3 16.4 16.4.1 16.4.2 5 2013-09-04 Contents 16.4.3 16.5 16.6 16.7 16.8 16.9 Chapter 17 Local Members - Examples..................................................................................................119 Renaming Members.............................................................................................................123 Excluding Members..............................................................................................................123 Member Insertion Filtering....................................................................................................124 Microsoft Excel Features for Report Layout.........................................................................125 Ad-hoc Data or Member Sorting..........................................................................................125 Several Reports in a Sheet .................................................................................................127 Restrictions with Several Reports in a Sheet........................................................................128 Report Highlight ..................................................................................................................129 Delete Reports ...................................................................................................................129 Report Refresh ...................................................................................................................131 Refreshing Reports..............................................................................................................132 User Options.......................................................................................................................135 17.1 17.2 17.3 Chapter 18 18.1 Chapter 19 Chapter 20 Sheet Options.....................................................................................................................139 General Sheet Options........................................................................................................139 Expand Options....................................................................................................................139 Use as Input Form................................................................................................................140 Member Recognition Activation...........................................................................................140 EPM Worksheet...................................................................................................................141 Totals Placement .................................................................................................................141 No Data and Zero Values.....................................................................................................143 Show as Microsoft Excel Comments....................................................................................144 Formatting Sheet Options....................................................................................................145 Row Header Indentation ......................................................................................................145 Display Name.......................................................................................................................146 Auto Fit Column Width.........................................................................................................146 Repeat Row Headers and Repeat Column Headers.............................................................147 Display Dimension Names...................................................................................................148 Empty Cell Default Value .....................................................................................................148 Member not Found Default Value.........................................................................................148 Apply Dynamic Formatting...................................................................................................149 Refresh Sheet Options.........................................................................................................149 Keep Formula on Data and Show Source Data in Comments ..............................................149 Calculate Parents in Hierarchies...........................................................................................150 Refresh Data on the Whole File when Opening it.................................................................151 Clear Data on the Whole File when Saving it........................................................................151 20.1 20.1.1 20.1.2 20.1.3 20.1.4 20.1.5 20.1.6 20.1.7 20.2 20.2.1 20.2.2 20.2.3 20.2.4 20.2.5 20.2.6 20.2.7 20.2.8 20.3 20.3.1 20.3.2 20.3.3 20.3.4 6 2013-09-04 Contents 20.3.5 20.3.6 20.3.7 20.3.8 Chapter 21 Show Unauthorized Cell Text ..............................................................................................151 Apply only Report Editor Definition for Faster Refresh..........................................................152 Restore Dynamic Selection on Refresh after Navigation......................................................152 Keep Formulas Static that Reference Report Cells .............................................................153 Report Navigation...............................................................................................................155 Going Back in the Navigation Actions..................................................................................155 Row and Column Axes Switch.............................................................................................156 Expand.................................................................................................................................156 Expand on Nested Axis........................................................................................................158 Collapse...............................................................................................................................160 Collapse on Nested Axis......................................................................................................161 Keep Member......................................................................................................................163 Exclude Member..................................................................................................................164 Double-Click Actions............................................................................................................166 Drill-Through.......................................................................................................................167 21.1 21.2 21.3 21.3.1 21.4 21.4.1 21.5 21.6 21.7 Chapter 22 Chapter 23 Quick Links.........................................................................................................................171 Creating Quick Links............................................................................................................172 Deleting Quick Links............................................................................................................172 Custom Members................................................................................................................175 Creating custom members...................................................................................................176 Custom Members Order......................................................................................................177 Modifying Custom Members................................................................................................179 Enabling or Disabling all the Custom Members Defined for a Sheet/Connection .................179 Deleting Custom Members .................................................................................................179 Custom Members Export.....................................................................................................180 Exporting Custom Members.................................................................................................180 Custom Members Import.....................................................................................................181 Importing Custom Members ................................................................................................182 Flash Objects......................................................................................................................183 Flash Object Creation, using EPM Connector......................................................................183 Connections and Operations................................................................................................184 Creating a Connection in Dashboard Design........................................................................185 Retrieve Data Using a Report...............................................................................................186 Retrieve Databases/Environments/InfoAreas ......................................................................187 23.1 23.2 Chapter 24 24.1 24.2 24.3 24.4 24.5 24.6 24.6.1 24.7 24.7.1 Chapter 25 25.1 25.1.1 25.1.2 25.1.3 25.1.4 7 2013-09-04 Contents 25.1.5 25.1.6 25.1.7 25.1.8 25.1.9 25.1.10 25.1.11 25.1.12 25.2 Chapter 26 Retrieve Cubes/Models/InfoProviders ................................................................................188 Retrieve Dimensions ...........................................................................................................189 Retrieve Dimension Members/Characteristic Values ..........................................................190 Input Data............................................................................................................................191 Retrieve Business Process Flows........................................................................................192 Retrieve Context..................................................................................................................193 Retrieve Text from Documents View....................................................................................194 Retrieve Members Property Values.....................................................................................195 Flash Object Insertion..........................................................................................................196 Dynamic Charts .................................................................................................................197 Chapter 27 Dynamic Formatting............................................................................................................199 Dynamic Formatting Template Definition..............................................................................199 Defining a Dynamic Formatting Template ............................................................................202 Dynamic Formatting Applied to a Worksheet or to a Specific Report...................................203 Applying a Default Dynamic Formatting Template to the Worksheet....................................203 Applying a Default Dynamic Formatting Template to a report...............................................203 Workbook Sheet Automatic Generation..............................................................................205 27.1 27.1.1 27.2 27.2.1 27.2.2 Chapter 28 Chapter 29 Offline Mode.......................................................................................................................207 Chapter 30 Worksheet Protection.........................................................................................................209 Chapter 31 Collaboration.......................................................................................................................211 Report Publication to a Web Portal.......................................................................................211 Publication and Distribution Connection...............................................................................212 Book Publication .................................................................................................................212 Distribution and Data Collection...........................................................................................222 EPM Functions....................................................................................................................231 EPMUser.............................................................................................................................234 EPMServer..........................................................................................................................235 EPMEnvDatabaseDesc........................................................................................................235 EPMEnvDatabaseID.............................................................................................................236 EPMModelCubeID...............................................................................................................236 EPMModelCubeDesc..........................................................................................................237 Functions on Reports...........................................................................................................237 31.1 31.2 31.2.1 31.2.2 Chapter 32 32.1 32.2 32.3 32.4 32.5 32.6 32.7 8 2013-09-04 Contents 32.7.1 32.7.2 32.7.3 32.7.4 32.7.5 32.7.6 32.7.7 32.7.8 32.7.9 32.8 32.9 32.10 32.11 32.12 32.13 32.14 32.15 32.16 32.17 32.18 32.19 32.20 32.21 32.22 32.23 32.24 32.25 32.26 32.27 32.28 32.29 32.30 32.31 32.32 32.33 32.34 32.35 32.36 32.37 32.38 EPMDimensionOverride.......................................................................................................238 EPMAxisOverride.................................................................................................................240 EPMCopyRange...................................................................................................................241 EPMInsertCellsBeforeAfterBlock.........................................................................................242 EPMMemberID....................................................................................................................243 EPMReportOptions..............................................................................................................243 EPMMemberSortingOverride...............................................................................................245 EPMReadOnlyData..............................................................................................................246 EPMSuppress......................................................................................................................246 EPMReportID.......................................................................................................................247 EPMFullContext...................................................................................................................248 EPMContextMember...........................................................................................................248 EPMDimensionProperty.......................................................................................................249 EPMDimensionPropertyValues............................................................................................250 EPMMemberDesc................................................................................................................251 EPMMemberProperty..........................................................................................................252 EPMMemberOffset..............................................................................................................252 EPMSelectMember..............................................................................................................253 EPMCellRanges...................................................................................................................254 EPMRefreshTime.................................................................................................................255 EPMScaleData.....................................................................................................................255 EPMDriverBasedRefresh.....................................................................................................256 EPMRetrieveData................................................................................................................257 EPMDimensionList...............................................................................................................258 EPMSaveComment..............................................................................................................259 EPMSaveData......................................................................................................................260 EPMSaveDataOnly..............................................................................................................261 EPMWorkStatus..................................................................................................................262 EPMComparison..................................................................................................................263 EPMDimensionType.............................................................................................................264 EPMCommentFullContext....................................................................................................265 EPMCommentPartialContext................................................................................................266 EPMURL..............................................................................................................................267 EPMBook.............................................................................................................................270 EPMLink..............................................................................................................................271 EPMPathLink.......................................................................................................................272 EPMDocumentList...............................................................................................................274 EPMDocument.....................................................................................................................275 EPMCellContextDocument..................................................................................................275 EPMExecuteAPI...................................................................................................................276 9 2013-09-04 ...................307 Standard Data Management Packages.....................................................................................................2.............................................................................305 About Data Manager............298 MDX Display...............................................................................................................2 33........2..............................................................301 Common Features to the Add-in for Microsoft Office Excel.....................297 Log File............................................................................................282 Data Disaggregation .............3.....................................................................................279 Data Input.............................................3 33................................................1 39.............3........307 Financial Process Packages .............282 Comments...........................................................................................301 Additional Features in the Add-in for Microsoft Office Word and PowerPoint ................................................................295 Chapter 37 Other Features....................1...................................................................................................................... Word and PowerPoint .................................................................................................290 Accessing Journals.............................................................2 33...............................................2 37............................................................2.........................................................................5 33.........................................................6 Chapter 34 Chapter 35 Business Process Flows...............305 About Data Manager...................................3 Chapter 39 39......293 Chapter 36 Report and Input Form Templates....................................................302 Options in the Add-in for Microsoft Office Word and PowerPoint ..................................................................................................................................................................................................................................................281 Trend...........2 33......................305 Standard Packages.................279 Planning Features.............3.................................................299 EPM Add-in for Microsoft Office Word and PowerPoint........................................2 10 2013-09-04 .....1 37......................................................281 Weight..............3 33....................................................3 37...................................................2.........................................................................................297 Metadata Cache..............................1 33.............286 Comment Search...............285 Comment Display in a Cell..280 Spread.......1 33................3 33.............................................................................................................................................................................4 Chapter 38 38......................1 39..................................2 38...................................................................................................291 33.......1 33...........303 Data Manager.................................................................................................................................................289 Work Status.....1 38.....2......................................................................Contents Chapter 33 Data Input and Save..........4 33................................................................................................298 Information on Cubes ..........................................284 Comment Creation and Modification........................................314 37...............................................................1 39.............................................287 Data Save................................4 33..............2 39....................................................288 Data Validation................................2........................ .....1 40....1.......418 GetDimensionList..............................................................417 GetMemberHierarchy .....................2............10 39...................315 About Additional Packages.................419 GetHierarchyList............................................353 About Data Transformations..........................................1....5......................................................................314 Additional Packages...................................369 About Data Transfer and Preview...................................................................5........................................................................5...1...............................1 39.............................394 Reports........5..3.....................5 39...............................347 Modifying the List of Selected Packages.................1...................................................................................................................7 39...........................5...9 39........................................................................................345 Defining a Package Link.........................................................................1..................7 39..........................6.........1 39.........................8 40...............1..................................420 GetHierarchyMembers ...........................................................................................................4..............3 39................................................................................................1..............................................................2 39....................................................................................1 40...........13 11 2013-09-04 .........349 Importing and Exporting Data Having Multiple Key Figures...............................349 Adding Multiple Process Chains to a Package.....1 39...........................................373 SetDimensionCaption..................................................1.........5 40................1 39..........4...............381 Options.......................4 39............1....351 Data Transformations and Conversions...................................367 Data Transfer and Preview..........2 39............................................................3 40.........................................................6..............................................5......................369 APIs......4 40........................................1.........5...........................382 Report Connections......................................................................323 Logic Use in Packages.........................................................6 39...........................................354 Data Conversions..................6 40...............................................................2 39......2 39..........5 39...........................416 SearchMember...............................................................................................1 Chapter 40 System Administration Packages..............................................................................................................................................................................................................................................................................................7............................349 Viewing Package Schedule Status........4 39..............................................................................11 40........421 40......................................................................................................................................................................................12 40......7 40.................................................373 Context.................350 About Delta Initialization.......................9 40...................................................Contents 39................343 Package Object Syntax ..............6 39.............350 Retracting Master Data and Transaction Data.........................3 39....345 Running Packages................................................................344 Data Manager Tasks.................344 Data Manager Tasks..4................323 Package Properties...322 Adding or Modifying Packages....420 Get MDX Request .......................................................5.......3 39....................3...........................................................................................................................................................................1............................................5........................................3 39..............1........................................8 39..............................................1...5............416 GetChildrenFromMember...................373 Macros....................5...........................315 Importing Transaction Data from an Information Provider .....................................................................................................10 40......................................................348 Viewing Package Status...11 39....................................2 40...................................................................399 GetMemberDimension ..............................................344 Removing a Package from the List.................. ....................................9 40.......438 Refresh.......................................2 12 2013-09-04 ........20 40...................................................1 41......................................14 40...................................................2...........2 40.......4 40..............................444 OpenSpecificDocument...............................................15 40.................................456 Interface Implementation Details..............................................17 40.....7 40.....................................................................................427 Connections.......1............................................................................................2........447 Assigning a Control Form to a Macro...........431 Drill Through.......................2 41.............................................................................xml Content.......2.................................................13 40............2...................................................................2................................................................................................................................................................................................................438 Options..2....................................433 Comments...............................................................................................3 40.......................................427 Excel...........................................................423 Open/Save Connections...........................429 Word and PowerPoint.........................................2....5 40..2..................446 Data Manager................................................................2.......................2....................443 Distribution and Collection.................................................................2....................................................1.............................................................6 40.................2.......................................................................................2..............................15 40...................438 OpenReportEditor....................442 Planning.........................................................................................................451 Custom VBA Functions (Events).......................................457 41.......432 Context Members........................................................................................16 40................440 OpenWorkStatusEditor..............................2 40......................437 OpenDimensionAndMemberSelector ......................1...............................453 Ribbon Extensions: Simple Method...............................................2..12 40........................................................................................................2.........................1..........................................................................................................2................................................................14 40......................Contents 40..................................19 40..................................10 40............................1 41.....................................................................421 EvDREs...451 Ribbon Extensibility.................439 Save Data....................425 Data Manager Connections.............................................436 Open/Save from Server.............................................................1...................11 40................................2.................................................442 Book Publication.........................................17 40.............................................................................................................................................................455 How to Create a Ribbon Extension .....................................2.....426 Macros used in EPMExecuteAPI function.....................................................453 RibbonXML.........1 40............................16 40....453 Ribbon Extensions: Advanced Method.....................430 Navigation..................18 40.................................................................3 40.............2........2........2.................................1 41...................2.426 LogOn...........................4 Chapter 41 Book Publication and Distribution.........8 40.......................................................... ........................................................475 SortRange..................480 OptionRange..........................................469 EvDRE Formula............2....................................................................2...............470 Report Members and Axes...486 Launching the EvDRE Migration....................2..............................................................Contents Chapter 42 Languages.............................................................470 KeysRange...480 Format Migration.........................1 44..............................................................................................................................................2 44...............491 493 44................................................................2.........................................3 44.............................481 Migration Log...........4 44...............................................................................................................................................................2.................................................2....................2....2..............................................................................469 Planning and Consolidation EvDRE Migration.10 Appendix A Index 13 2013-09-04 ......7 44..................................................................................................487 After Migration...............471 ExpansionsRange.......................................9 44.............................6 44......................................................................................................................................................................................................................................467 Chapter 44 Migration...........................465 Chapter 43 About the EPM Add-In.......2 44.................................489 More Information..............................................................1 44....................................2................................................................2.....................469 Extended Analytics Analyzer Report Migration............................................................................................5 44....8 44.. Contents 14 2013-09-04 . See Display Dimension Names. you can perform data disaggregation. you can now ask that the whole worksheet be refreshed on an expand or collapse action. See ExpandActiveSheet and ExpandActiveSheetExpandEventsOnly.What's New What's New 1.1 What's New in Support Package 15 Connection to SAP HANA Cubes Using a new local connection. or for the current report (in the Report Options of the Report Editor). version for SAP NetWeaver. you can choose other member names to display. New API: ExpandActiveSheetExpandEventsOnly An additional API enables you to expand data and metadata only for the active sheet that contains EVDRE. you can analyze the data of SAP HANA cubes. Displaying Member Properties from the Member Selector You can display the properties of a selected member from the Member Selector. 15 2013-09-04 . Alternatively. Customized Member Names For Planning and Consolidation connections. For more information and to view an example. This is a quick and one-shot sorting. Data Disaggregation When connected to a Planning and Consolidation. the report is refreshed on an expand or collapse action. See Data Disaggregation . see EPM Functions. Ad-hoc Sorting You can sort the data or the members of the column axis of a report. See Member Properties. Displaying Dimension Names in the Reports You can choose to display the names of the dimensions used in the row and column axis of all the reports in the worksheet (in the Sheet Options). See Ad-hoc Data or Member Sorting. See Member Name to Display. model on SAP HANA. Automatic Worksheet Refresh on Expand/Collapse By default. you can now specify directly the email addresses of the users in the distribution template.Specifying emails directly To send the distribution workbooks as attachments in emails. See Book Publishing and Launching Book Publication. 16 2013-09-04 . Distribution .2 What's New in Support Package 14 Documentation Patch 03 GetUserOption and SetUserOption APIs The GetUserOption and SetUserOption APIs are available. See Repeat Row Headers and Repeat Column Headers. See Drill-Through. you can specify a text qualifier for transformation files. Defer Layout Update now Persistent The Defer Layout Update option in the EPM tab is now persistent.Saving the Log as Zip File You can now save the log as a zip file. Member Search Modification in Member Selector This is specific to the Member Selector available for large volume data sources. For more information on the option. 1. Data Manager . 1. see Report Creation using the EPM Pane. Book Publication in Microsoft Excel Workbook You can publish books in one single Microsoft Excel workbook. when using a Planning and Consolidation connection.New Transformation File Option: Text Qualifier In the Data Manager. Drill Through to Table This is specific to large volume data sources: You can now display information contained in a SAP table. for any specific parameters that have been specified in a provided file.3 What's New in Support Package 14 Documentation Patch 02 Repeat Row Headers sub-Option to Improve Refresh Performances To improve refresh perfomances. Data Manager . See EPMReadOnlyData.What's New EPMReadOnlyData The EPMReadOnlyData enables you not only not to save the data entered on specific ranges but now also the data entered on the whole report. See GetUserOption and SetUserOption. you can select the new option Use Excel Cell References. 4 What's New in Support Package 14 Documentation Patch 01 Launching the Member Recognition at any Time If you have not activated the Member Recognition. Defining Additional Member Names Since support package 13. Use the new option Edit Context Options in the Protection tab of the Sheet Options. This option is selected by default. Now. when a worksheet is protected. For more information on worksheet protection. using the 17 2013-09-04 . 1. Hierarchy and Version Display in the EPM Pane This is specific to large volume data sources. • Also. you can launch it on an ad-hoc basis at any time. the member search is now displayed in a dedicated area of the Member Selector. The new user option Members Displayed on Node Expansion in Member Selector enables you to define the maximum numbers of members that should be loaded and displayed when you expand a node in the Member Selector. See Member Entry Using the Member Selector (on Large Volume Data Sources). for reports connected to a SAP NetWeaver BW InfoCube (using a local connection). See Member Entry Using the Member Selector (on Large Volume Data Sources). you can filter members based on property values. you can select the context member of a specific dimension as the property value. Context Options on Protected Worksheet You can now specify if you want to be able to edit the context options using the Context Options dialog box. Member Insertion Filtering and Dynamic Formatting Template Definition. you can restrict the search to members and descendants of one or more specified members. Tree View in Member Selector This is specific to the Member Selector available for large volume data sources. See Launching Member Recognition.What's New • • When clicking the binocular icon. See Member Filtering by Properties. If the data source contains versioned hierarchies. Member Entry Using the Member Selector (on Large Volume Data Sources). see Worksheet Protection. you can display the hierarchies and versions in two ways in the EPM pane. For more information on the Member Selector used for large volume data sources. Member Selection by Context Property Using the Member Selector. you were able to define other member names to display. based on properties. see Member Entry Using the Member Selector (on Large Volume Data Sources). as the concept of pages is no more needed. For BW data sources. the user option Members per Page in Member Selector has been removed. and no more in a dialog box. • The members are now displayed in a tree view. based on a specified range of data drivers whose values you can modify. You can now define other member names for any data source. EPMDriverBasedRefresh The EPMDriverBasedRefresh function enables you to refresh specific rows or columns of one or more reports. Interface Areas Modified in Read-only Data. You can also rename a dimension using an API. See GetMem berDimension and SearchMember. Member Insertion Filtering and Excluded Members tabs of the Report Editor. new parameters are available in the following prompts. Collapsing Dimension Tree View You can now specify that the dimension tree view be collapsed by default. Restriction on Local Members A note has been added to the documentation. See Report Creation using the EPM Pane and Report Editor's Layout Tab Presentation. Additionally. SELECTINPUT. New Parameters in Certain Prompts . that enables you to specify the default members to be taken into account in the package interface: SELECT.xml file located in the EPM add-in installation folder.Data Manager Applies to: Planning and Consolidation connections In the Data Manager. See Context Display Options. finding a row by pressing a key. See the Data Manager section of this documentation. Excluded Members and Member Insertion Filtering Tabs In the Read-only Data. performing a search. See Local Member Creation. New APIs Available for Benchmarking Purposes Two APIs are now available for benchmarking purposes and for local connections only. 18 2013-09-04 . See EPMDriver BasedRefresh. COPYMOVEINPUT. the interface has been redesigned. Excluding Members and Member Insertion Filtering. Sort and Search Actions in the Connection Manager You can now perform the following additional actions in the Connection Manager: sorting the list of connections based on the connection name or the server. Renaming Dimensions You can now define customized names for any dimension. stating that it is not possible to create a local member in a child report.What's New the ProviderCapabilityConfiguration. See SetDimensionCaption. COPYMOVE. you can specify to refresh a whole report that is outside of the specified range of data drivers. See Read-only Data. See Member Name to Display. See Connection Management. local members on the columns axis override the ones on the row axis by default. based on specified members. See Large Volume Data Sources. Additionally. you can now choose other member names to display as alternatives to the captions. See Context. EPMSuppress The EPMSuppress function enables you to remove a row or column. See User Options. See Context Display Options. Ordering Dimensions The default order of the dimensions as they appear in the EPM Context bar now also applies to the other interface areas where the list of dimensions is displayed.5 What's New in Support Package 14 Documentation Entering Members Manually in the EPM Context bar You can enter directly the complete ID of a dimension member in the EPM Context bar dropdown lists provided that the Enable Manual Entry of Members option is selected in the User Options. You can now change the precedence by selecting a dedicated option. See Data Save.What's New 1. all data are sent to the server to be saved: base member data and parent data. If the members specified do not contain any data. you can now unselect the user option Send Parent Data to the Server on "Save Data". you can now specify that you want to use the navigation attributes. Applying a Specific Formatting to Large Key Figure When connected to an SAP BusinessObjects Planning and Consolidation. Precedence Rule for Local Members In case of conflicts between local members on row and column axis. Not Sending Parent Data to the Server on Data Save By default. you can apply a specific formatting to the rounded data that exceeds the Microsoft Excel limit of 15 significant digits. you can specify to remove a row or column that contains zero values. See EPMSuppress. See Report Refresh .Specific to Large Volume Data Sources When creating a local connection to a SAP NetWeaver BW InfoCube. such as the EPM pane and the Report Editor. Refreshing Specific Worksheets You can perform a refresh only on the worksheets you select. See Local Members. If you do not want to send the parent data to the server. Navigation Attributes . 19 2013-09-04 . Member Names in the Formatting Sheet In the Dimension Member/Property Formatting section of the formatting sheet. the row or column is removed. model. version for SAP NetWeaver. See RefreshReportDataOnly. See Context Favorites. See Offline Mode. Context Favorites When frequently using the same context. See Read-only Data. 20 2013-09-04 . See RefreshConnectionMetadata. User Options Display Tab In the User Options dialog box.What's New Using BW Reverse Sign Property . See Keep Formula on Data and Show Source Data in Comments . • The SetContextOptionsForSeveralDimensions API. See SetContextOptionsForSeveralDimensions. See Metadata Cache. formulas are not kept.Specific to Large Volume Data Sources Using a local connection. See User Options. You can then select the context favorite from the EPM Context bar. Metadata Cache The metadata cache section has been updated. See Logging On and Off. See GetSheetOption. Read-only Data Restriction The member selection is always static. Metadata Refresh You can refesh the metadata of a specific data source at any time. you can save it as a context favorite. See LogOn. when connected to SAP NetWeaver BW InfoCube. 1. The RefreshConnectionMetadata API is also available. See Large Volume Data Sources.6 What's New in Support Package 13 Patch 02 Documentation "Keep Formula on Data" Sheet Option Restriction When you change a member in an axis. API The following API are available: • The RefreshReportDataOnly API. the BW Reverse Sign property is now taken into account when you select a dedicated option. using for example the EPM Context bar. • The GetSheetOption API. Offline Mode without Workbook Protection You can switch a workbook to offline mode without protecting it. • The LogOn API. instead of having to select each dimension member from the bar. the new Display tab has been created and certain options have been moved from the Others tab to the Display tab. in a simpler way. Drill-Through A drill-through to cube enables you to display information from another cube.xml file.7 What's New in Support Package 13 Documentation Connection Name parameter in EPM functions You also have the option to enter the name of a model instead of the connection name. See Page Axis Dimension Members Modification using the Member Selector and Collapse. Ribbon Extensibility: Another Method for Creating Extensions You can create extensions to the EPM tab of the Microsoft Office Excel Ribbon. See Member Entry Directly in a Sheet. For example. For example. Using Time-Dependent Hierarchies When connected to a Planning and Consolidation. version for SAP NetWeaver. the parent member is displayed instead and is taken into account in the report.What's New Keep Formulas Static that Reference Report Cells If you use Microsoft Excel formulas that reference cells (data or member cells) of a report and if you want the formulas to be static. the double-click will not function. for any specific parameters that have been specified in a provided file. New API: OpenMemberSelector The new API OpenMemberSelector opens the Member Selector that enables you to select members for a specified dimension and a specified connection. See Large Volume Data Sources. provided that you are not connected to other models that have the exact same name. EPM Functions with Double-Click Actions If the cell on which you double-click is merged with other cells. model. you can use time-dependent hierarchies in your reports. See Keep Formulas Static that Reference Report Cells . OpenMemberSelector. using macros and an . Member Parent Selection in Page Axis When performing a Collapse (Collapse command in the EPM tab) on a member cell located in the page axis of a report. See Ribbon Extensions: Simple Method. Specific Formatting for Unrecognized Members An option enables to apply a specific formatting to unrecognized members. EPMContextMem ber. 1. 21 2013-09-04 . This is possible only when a single member is selected for a dimension located in the page axis. you can select the Keep Formulas Static that Reference Report Cells option in the Sheet Options. See Time-Dependent Hierarchies. EPMContextMember. Connection for Open. Key-Medium Name. based on properties.config file defines . API SetSheetOption The protection options are now documented. By default. for example. you can customize the member names you want.What's New New Event: GetMaxTupleByCellRequest The parameter SmartQueryEngineMaxTupleByCellRequest in the FPMXLClient. New Member Names .dll.the maximum number of tuples (member combinations) by query when a refresh is performed. EPMOlapMember Formula The EPMOlapMember formula is now the following: =EPMOlapMemberO( However. To change the number of tuples.xml file located in the EPM add-in installation folder.for EPM functions . See SetSheetOption. Save. Book Publication and Distribution Actions You can change the connection in two ways. if your workbook contains a lot of EPM functions such as EPMRetrieveData. 22 2013-09-04 . Key-Caption. The member name is taken into account in the report. This parameter cannot be modified during a session for a specific workbook. both of these formulas are recognized: =EPMOlapMemberO( and =EPMOlapMember(. Key-long Name. The number entered will override the SmartQueryEngineMaxTupleByCellRequest number. you can now choose other member names to display. See Publication and Distribution Connection and Open and Save Connection . EPMSaveData and EPMSaveComment. the concatenated names are proposed in the display name list in the Member Selector. See Large Volume Data Sources. See Custom VBA Functions (Events). you can now change the number of tuples during a session for a specific workbook.Specific to Large Volume Data Sources In a report connected to a SAP NetWeaver BW InfoCube (using a local connection). For performance reasons. depending on what is defined in the ProviderCapabilityConfiguration. In this file. the following name combinations are provided in the file: Key-Name. use the GetMaxTupleByCellRequest event. If the properties exist in the hierarchies. cube designer. • SAP BusinessObjects Profitability and Cost Management models. models. • SAP BusinessObjects Planning and Consolidation. the Data Manager tab is added to the Microsoft Office Excel ribbon. you can use the EPM add-in 10. The EPM add-in is designed to give access to SAP Business Objects EPM Solutions' product data. • SAP NetWeaver BW InfoCubes created with SAP BusinessObjects Financial Consolidation. cube designer. When working with a Planning and Consolidation connection. version for the Microsoft platform. see Types of Connections. The add-in also permits analysis of data from several EPM solutions at the same time. and providing reporting and delivery tools.Introduction to the EPM Add-in Introduction to the EPM Add-in The EPM add-in is an add-in to Microsoft Office Excel. In addition. Microsoft Office Word and Microsoft Office PowerPoint. • SAP HANA cubes. • SAP BusinessObjects Planning and Consolidation. The EPM add-in enables you to analyze data. models. transforming that data in real time into a form which supports reporting. You can use the EPM add-in on any other non-EPM SSAS cubes and SAP Business Warehouse InfoCubes. The EPM add-in also enables you to enter data in SAP BusinessObjects Planning and Consolidation models. cube designer.5. Note: Depending on the connection you use.0 to retrieve and analyze data that comes from the following 7. copy or move data within and across applications. For more information on connections. For more information.5 Data Sources In replacement of Extended Analytics Analyzer 7. see the Data Manager section. Retrieving Data from 7. the Data Manager supports mapping and complex transformations of data. 23 2013-09-04 . provided that you use the appropriate connection. The EPM add-in enables you to analyze the data of the following OLAP data sources: • SSAS cubes created with SAP BusinessObjects Financial Consolidation.5 data sources: • SSAS cubes created with SAP BusinessObjects Financial Consolidation. and export data from an application for use in an external tool. version for SAP NetWeaver. The Data Manager is a Planning and Consolidation module that helps you move data into the system. The Data Manager also allows you to export transactional and master data from an application within Planning and Consolidation to a file that you can use in an external tool. some EPM features are not supported and therefore the commands are automatically hidden or greyed out. 24 2013-09-04 . This prevents conflicts between EV function names.5 Planning and Consolidation model) and EPM add-in 10. SAP BusinessObjects Planning and Consolidation.0 Planning and Consolidation model). models. Note: • • Use local connections (. version for the Microsoft platform.0 (on a 10. version for SAP NetWeaver.5 (on a 7. When using both add-ins.oqy files) to connect to the data sources though ODBO.Introduction to the EPM Add-in • • • SAP NetWeaver BW InfoCubes created with SAP BusinessObjects Financial Consolidation. cube designer. uncheck the Load EV Functions option in the User Options of the EPM tab. models. SAP BusinessObjects Planning and Consolidation. Planning and Consolidation Interface for Microsoft Excel 7. Also see EPM Functions. This note applies to Planning and Consolidation Local connections. Note: When the EPM add-in is not installed and you try to open an existing EPM workbook or to create a new one. • Download the EPM add-in from the SAP BusinessObjects Enterprise BI launch pad. proposing to install the application by choosing Install the EPM add-in for Microsoft Office. Once you are logged on to the BI launch pad. add-in for Microsoft Office Installation guide.Installation and Update Installation and Update • • You can install the EPM add-in in several ways. indicating that the application is not installed. If using a Planning and Consolidation connection. version for SAP NetWeaver and SAP BusinessObjects Planning and Consolidation. 25 2013-09-04 . When you choose OK. • Launch the setup. see the SAP BusinessObjects EPM Solutions. • Download the EPM add-in from the SAP BusinessObjects Planning and Consolidation web client. Once you are logged on to Planning and Consolidation. another dialog box opens. a dialog box appears.1 Installation There are several ways of installing the EPM add-in for Microsoft Office. version for the Microsoft platform. once the EPM add-in is installed on your local machine. 3. For more information about hardware and software prerequisites to installing the EPM add-in. 3. select Install EPM add-in for Microsoft Office. you can install the updates.2 Update Applies to: SAP BusinessObjects Planning and Consolidation. The add-in is automatically loaded when you open Microsoft Office Excel. Microsoft Office Word or Microsoft Office PowerPoint. launch the installation in the Preferences area. 3 Re-activating the EPM Add-In If the EPM add-in has been deactivated. 5. If you do not install the update. Select Disabled Items from the Manage dropdown list and click the Go button. 1. select EPM > About > Check for Updates. depending on the update policy defined on the server side.exe from the installation folder and selecting Enabled from the dialog box that opens. When connecting to a Planning and Consolidation server. when using a connection to a Planning and Consolidation server. click the Office button. prompting you to install the update. To do so. 4. select the SAP BusinessObjects EPM Solutions. Click the Close button. Note: You can also quickly re-activate the EPM add-in by executing the AddinManager. then click the Excel Options button. a message appears every time an update is available. without specifying anything on your side. select the Notify me when updates are available option in the User Options. You can verify at any time whether or not updates are available. add-in for Microsoft Office and click the Enable button. 3. you can either choose the Do not show this message again option in the message box that appears or deselect the Notify me when updates are available option in the User Options. In the Disabled Items dialog box. you can re-activate it. Note: • If you do not want to be notified again for updates. when connecting to a Planning and Consolidation server. The following options are possible: • To be notified whenever an update is available. For updates that are defined as "auto update" on the server side. a message appears every time an update is available. Related Topics • User Options 3. you can install the updates. In the Excel Options dialog box. the user option is automatically unchecked. • • • When updates are mandatory.Installation and Update Once the EPM add-in is installed. 2. 26 2013-09-04 . asking you whether you want to install it now or later. The Notify me when updates are available option takes effect and the Do not show this message again option is displayed only for updates that are defined as "user update" on the server side. meaning that when the first one in the message box is checked. select Add-Ins. In Microsoft Office Excel 2007. a message appears on your local machine. asking you whether you want to want to install it now or later. (defined as "force update" on the server side). you cannot use the EPM add-in. These two options are synchronized. When you open a workbook containing several reports and you log on with a specific connection. or is left blank and you need to click the ellipsis button to select a connection in the Connection Manager dialog box that opens. you need to use a connection. metadata is loaded. To log on. Metadata Refresh When logging on. A connection establishes a connection between a specific data source and a report. You can refesh the metadata of a specific data source at any time. 4. if you have defined one. The connections are managed in the Connection Manager dialog box. The Logon dialog box proposes the default connection. in which case you may have to enter the login and password to one or more connections. all the other connections used by the other reports in the workbook are automatically connected . Related Topics • Active Connection for the Current Sheet 27 2013-09-04 . the Log On ribbon button is hidden and the Log Off button is displayed.1 Logging On and Off Logging on enables you to establish a first connection between all the workbooks (for one Microsoft Excel instance) and a cube or model. select EPM > More > Refresh Metadata for Current Connection. you select a first connection for the workbooks. If you open another workbook containing reports. When you log on. Once you are connected to a data source. The connection selected is considered as the active connection. metadata is loaded and refreshed with the dimensions or members that have been added in the data source since the last logon. To do so. avoiding to perform a log off and log on.Logon and Connections Logon and Connections To access a specific cube or model with the EPM add-in. select EPM > Log On. meaning that the dimensions and members of the data source (cube or model) are loaded. When logging off and then logging on again.unless for example a connection has been deleted. Logging off disconnects all the connections used in the current workbook. The metadata is refreshed right away for the connection that is displayed in the Connected to area of the EPM Pane. the connections will also be automatically connected. The search is performed on both connection names and servers. The Connection Manager can be opened in the following ways: • Select EPM > Report Actions > Manage Connections • Click Log On.Logon and Connections 4. If you want local connections to always be displayed when you open the Connection Manager. select a connection in the list and click Set as Default. You perform the following actions in the Connection Manager: • • Select a connection. all the connections that you have at one time selected are displayed. including local connections. in the Connection Manager. you can disconnect several sheets at the same time. Selectively connect or disconnect one or more sheet/connection pairs. • • • • • • Related Topics • Features Available • Report Creation • EPM Functions • Types of Connections • Selecting Connections • Selectively connecting or disconnecting sheet/connection pairs 4. To do so. Search for a connection by using the entry area at the bottom of the dialog box. Duplicate a Planning and Consolidation connection. For example.2 Connection Management The connections are managed in the Connection Manager dialog box.3 Active Connection for the Current Sheet 28 2013-09-04 . provided that the Display Local Connections option is selected. Press a key and the next row beginning with the key is selected. Set a default connection. when a workbook contains a large number of sheets that you do not want to be connected. Sort the list of connections based on the connection name or the server. then select the ellipsis button • Select Select Another Connection from the Active Connection drop-down list of the EPM pane. The connection will be proposed by default when you log on. by clicking the Connection Name header or Server header. Edit or delete a connection. select the Display Local Connections option in the User Options. When you open the Connection Manager. You can set a connection as the default one. This connection is the active connection for all the workbooks. Planning and Consolidation. depending on your environment. the EPM add-in enables you to analyze the data of the following OLAP data sources: • SSAS cubes created with SAP BusinessObjects Financial Consolidation. models. • SAP BusinessObjects Profitability and Cost Management models.4 Types of Connections There are several types of connections available. Using a Planning and Consolidation. SAP BusinessObjects Enterprise. MultiProvider and VirtualProvider). version for the Microsoft platform. the EPM add-in also enables you to enter data on SAP BusinessObjects Planning and Consolidation models. version for the Microsoft platform. You can select at any time another connection that will become the active connection for the current sheet. version for SAP NetWeaver. The connection you select in the list is the active connection for the current sheet until you select another one. you select a first connection. They include: Local. • SAP HANA cubes. They can modify the structure of the cubes and models at any time. • SAP NetWeaver BW InfoCubes created with SAP BusinessObjects Financial Consolidation. Note: Administrators create the cubes and models to which you connect your reports. and other types. When you perform a log on. version for the Microsoft platform connection. version for SAP NetWeaver or Planning and Consolidation. 29 2013-09-04 . The active connection is selected in the Active Connection dropdown list of the EPM pane. Using a Local or an SAP BusinessObjects Enterprise connection. cube designer (note that only the following objects of the SAP BW ODBO provider are supported: InfoCube. models. cube designer. The connections that are available in this list are the connections that you have connected during your current Microsoft Excel session. you can use and select the connection types explained in the following section. • SAP BusinessObjects Planning and Consolidation. • SAP BusinessObjects Planning and Consolidation.Logon and Connections The active connection is the one that is used when you create a report or enter an EPM function. Related Topics • Several Reports in a Sheet • EPM Functions 4. version for SAP NetWeaver. Planning and Consolidation. In the Connection Manager. see the SAP BusinessObjects EPM Solutions. Select one of the following: 30 2013-09-04 . When connecting to a cube/model. If the data source for which you are creating or editing the local connection is a large volume data source. These connections can be stored on your machine or another machine on the network. For more information. see Large Volume Data Sources. click the Local Connection Folder button in the Connection Manager and select the folder in the dialog box that opens. To do so. add-in for Microsoft Office Installation guide. you will only need to select the ones you require. and select your working language. If you have opened the EPM add-in from the BI launch pad. add-in for Microsoft Office Installation guide. Note that the cube/model will take some extra time to load. some features are not supported and therefore the commands are automatically hidden or greyed out. Depending on the connection you use. select the Do not Load Members at Connection option. you must enter the user name and password to the SAP NetWeaver BW platform. • • Planning and Consolidation Connections Refer to the SAP BusinessObjects EPM Solutions. Local Connections Local connections are .5 Selecting Connections 1. You must edit the connection in the Connection Manager and specify its authentication method. Notes on Connections • • • For more information about connections and their authentication method.Logon and Connections SAP BusinessObjects Enterprise Connections SAP BusinessObjects Enterprise Connections are connections that are stored on the SAP BusinessObjects Enterprise platform. then the authentication method has not been defined. you can use these connections. Note: • If the connection was not created using the EPM add-in. Related Topics • Features Available • Metadata Cache 4. When you connect to an SAP NetWeaver BW InfoCube. You can select folders in which your administrator stores the local connections. and a message appears when trying to connect. Any connection added at a later time to this folder will be retrieved automatically. you can clear the cache if you want to load the whole structure and not just the data. Selecting this option has consequences for the Member Selector and certain other features.oqy files. version for the Microsoft platform or a Local connection.6 Selectively connecting or disconnecting sheet/connection pairs 1. version for SAP NetWeaver. Select one of the following: a. Note: If you have not opened the EPM add-in from the BI launch pad. you msut enter the user name and password to the SAP NetWeaver BW platform. When you connect to an SAP NetWeaver BW InfoCube. From the Active Connection drop-down list of the EPM pane. c. including local connections. see the SAP BusinessObjects EPM Solutions. when you select this type of connection. select Select Another Connection. 3.Logon and Connections a. If the connection you want to use is not in the list. Enter a name for the connection. select the Display Local Connections option in the User Options. 31 2013-09-04 . and select your working language. To do so. click Create and do as follows: • If you have opened the EPM add-in from the BI launch pad. The Connection Manager opens. You can select folders in which your administrator stores the local connections. EPM > Log On b. select Select Another Connection. EPM > Log On b. Planning and Consolidation. provided that the Display Local Connections option is selected. EPM > Report Actions > Manage Connections. • To create a Planning and Consolidation. you can select the SAP BusinessObjects Enterprise connection type. displaying the list of all the connections that you have at one time selected. From the Active Connection dropdown list of the EPM pane. 2. the list of EPM connections is empty. Any connection that is added at a later time to this folder will be retrieved automatically. Select a connection from the list and click OK. Click Report Connections. then select an EPM connection in the list. c. add-in for Microsoft Office Installation Guide. refer to the SAP BusinessObjects EPM Solutions. add-in for Microsoft Office Installation Guide. click the Local Connection Folder button in the Connection Manager and select the folder in the dialog box that opens. and select the cube or model. 2. Note: • • If you want local connections to always be displayed when you open the Connection Manager. Note: For more information about connections and their authentication method. EPM > Report Actions > Manage Connections The Connection Manager opens. 4. For more information on this option. click the Unselect All button and then click OK. one report can only be connected to one cube/model at a time. click the Select All button and then click OK. select or deselect all the sheet checkboxes individually. sheets and reports. You can perform the following actions: • To connect or disconnect a specific sheet/connection pair.Logon and Connections The Report Connections dialog box opens. see EPM Worksheet. the previous cube/model will be disconnected. select the cube/model. Note: If you connect a report to a different cube or model. • To connect or disconnect all the sheets linked to a cube/model. select or deselect the sheet checkbox and click OK. or select or deselect the cube/model check box and click OK. the EPM Worksheet option in the General tab of the Sheet Options is automatically selected or deselected. • To connect all the sheet/connection pairs. the sheet or the report and click the Change Connection button. All connected sheets in all open workbooks in the current session of Microsoft Office Excel appear in the tree view list displaying cubes/models. Note: You can choose how to display the sheet/connection pair by clicking the Display by Sheet or Display by Connection button. 32 2013-09-04 . • To disconnect all the sheet/connection couples. If you connect or disconnect a sheet/connection pair. In other words. • To change a connection. 3. Hierarchy and Version Display in the EPM Pane If the data source contains versioned hierarchies. Selecting this option has consequences for: • the Member Selector and any user interface areas where you can perform a member selection. The button located in the current report area (containing the v and h letters) enables you to group the versioned hierarchies by version or by hierarchy. select the Do not Load Members at Connection option in the Edit Connection and Create Connection dialog boxes. For more information about the Member Selector. you can specify that you want to use the navigation attributes. The members are only loaded as you navigate and display them in a report. the navigation attributes will be displayed in italic in the EPM pane. 5. • some features are specific to large volume data sources. the BW Reverse Sign property is taken into account in the EPM add-in if you select the option Use Reverse Sign Property in the Sheet Options or in the Options tab of the Report Editor. you can choose not to load all the members at once at the connection. For more information on local connections. and if you select the Use Navigation Attributes option in the connection dialog box. To do this. Note: This feature is only available for local connections. you can display the hierarchies and versions in two ways in the EPM pane. Navigation Attributes When creating a local connection to a SAP NetWeaver BW InfoCube.Large Volume Data Sources Large Volume Data Sources When you connect to a data source . They are listed below. Provided that the navigation attributes are defined on the InfoCube side.using a local connection . see Member Entry Using the Member Selector (on Large Volume Data Sources). when connected to SAP NetWeaver BW InfoCube. • some specific features that are not supported or restricted. when creating or editing a local connection.1 Restrictions on Specific Features 33 2013-09-04 .that has a large volume of members and for which the connection time is too long. see Types of Connections. Using Reverse Sign Property Using a local connection. They are also listed below. other restrictions exist. • The Freeze Data Refresh option is available but not applied. In the formula bar. You can use the following two functions only if you specify the member ID in the member parameter: EPMAxisOverride.Large Volume Data Sources When the Do not Load Members at Connection option is selected for a data source. EPMWorkStatus. see Data Sorting. EPMRetrieveData. see Excluding Members. For more information about functions. Filtering and Ranking tabs of the Report Editor: • • • • In the Sorting. • Do not use the following EPM functions as they are not supported when connected to a large volume data source: EPMMemberProperty. See Freeze Data Refresh. • If the provider used for the connection does not support custom members. see Book Publication . EPMScaleData. the number of children for a node is displayed. EPMSelectMember. Tip: To find out the member ID. the Retain Members button is not available. display the member in a report and select the member. see EPM Functions. For more information on data sorting. • The Display Warning when Process Takes Time option is available but not applied. EPMMemberDesc. EPMBook and EPMExecuteAPI (when you reference members). • For more information. • When there are at least three dimensions in an axis. see Member Entry Using the Member Selector (on Large Volume Data Sources). the book templates are not supported. the ID is displayed right after =EPMOlapMemberO(" • In the Member Selector: • • • the Member Property and Dimension Property relationships do not exist. See User Options. 34 2013-09-04 . Filtering and Ranking tabs of the Report Editor. EPMMemberOffset. EPMSaveData. For more information about excluding members. filtering and ranking.0. • Excluding members: • When excluding members. the following features are not supported or are restricted: • Books. you cannot have the same combination of members twice in an axis. EPMCommentPartialContext. In the Filtering tab: the Filter on all Columns/Rows option is not available. depending on the data source. In the Sorting tab: the Sort Inside Level option is not available. EPMSaveComment. the is/is not null drop-down menu is not available. • Sorting. it does not support blank members either. EPMDimensionsOverride. For more information about books. the Show Only Members Displayed in the Report option does not exist. EPMDimensionPropertyValues. not the number of ascendants. EPMCommentFullContext. Ranking and Filtering . you can either exclude one member or the whole combination of members. If a book template has not been generated with the EPM add-in 10. In the Ranking tab: the First Column and Last Column options are not available. However. Example: The entity member and its children are mentionned as follows in the MDX query: {[ENTITY]. The DrillThrough. for any specific parameters that have been specified in the DrillThrough. copy it at the following location: \%userprofile%\AppDa ta\Local\EPMOfficeClient\. Enter the name of the macro. Drill-Through to Cube A drill-through to cube enables you to display information from another cube. the row and column members at the interersection of the data cell selected. the destination cube must also use SAP BusinessObjects Enterprise connection. enter only the redirection information. In order to use it. Add double hashes (##) as follows: {## ENTITY##. 35 2013-09-04 .Large Volume Data Sources 5.2 Drill-Through You can display information from another cube or from a SAP table. • <MDXQuery>: MDX query of the destination report. The information displayed depends on the following items: • The context of the data selected. for any specific parameter that have been specified in the DrillThrough. Do not define any drill-throughs in the current file. Inside the query. The parameter <Redirection> enables you specifies another file where drill-throughs are defined (a file on the network shared by several users for example).[All]. Another worksheet opens. • <DisplayName>: name of the command that will be displayed when selecting EPM > Drill Through > Drill-Through to Cube from the EPM tab of the ribbon. Note: • The source report can be connected any connection. displaying a static report. [ENTITY].xml file. • To access the drill-through information. which is defined in the DrillThrough. The source cube and the destination cube can be located either on the same server or on two different servers.CHILDREN. you can put all the variable members between double hashes (##). select a data cell that belongs to the report.xml file is automatically placed in the EPM add-in installation folder. if the source report uses a SAP BusinessObjects Enterprise connection.[All]} You want the entity member and its children to vary. You can use this file as a template. Enter the path and name to the other file.CHILDREN. Here is the description of the parameters that need to be filled in: • <DrillThroughToCubeInfo>: defines one drill-through. then select EPM > Drill-Through > Drill-Through to Cube and the name of the drill through.xml file. • The parameters that have been specified in the DrillThrough.xml file. ##ENTITY##} • <VBAFunctionBeforeDrillThrough>: executes a VBA macro before executing the drill-through (for example: displaying a comment before the report).xml file. Note: <DrillThroughToSAPTableInfo> and <DisplayName> are mandatory. The source cube and the destination table can be located either on the same server or on two different servers. which is defined in the DrillThrough. You can put all the variable members between double hashes (##). Here is the description of the parameters that need to be filled in: • <DrillThroughToSAPTableInfo>: defines one drill-through to SAP table. for any specific parameters that have been specified in the DrillThrough. • <Table>: name of the SAP table. To access the drill-through information. displaying a static report.oqy file. The information displayed depends on the following items: • The context of the data selected. NOT LIKE. Another worksheet opens. etc). • <Query>: query of the SAP table. <ConnectionInfo>: connection information of the SAP table. Drill-Through to SAP Table A drill-through to SAP table enables you to display information from a SAP table. If you fill in these two pieces of information.xml file. • The parameters that have been specified in the DrillThrough. the row and column members at the interersection of the data cell selected. • <Fields> <Field>: name of the column you want to request information from. select a data cell that belongs to the report. Specify the connection information only if the destination cube is on another server. <IsEPMSheet>: enter TRUE to make the destination worksheet an EPM worksheet.Large Volume Data Sources • • • <VBAFunctionAfterDrillThrough>: executes a VBA macro after executing the drill-through (for example: applying formatting settings). 36 2013-09-04 . <ConnectionInfo>: connection information of the . Enter the name of the macro. • <Filters> <Filter>: define filters using SQL language (LIKE. <Filters><Filter>GROUP LIKE '%AF%'</Filter> <Filter>GROUP NOT LIKE '##ENTITY##PROPERTY(Long Name)##%'</Filter> </Filters> • • <MaxRows>: maximum of rows you want to retrieve. Specify the connection information only if the destination table is on another server. the whole content of the specified SAP table will be displayed in a new worksheet. • <DisplayName>: name of the command that will be displayed when selecting EPM > Drill Through > Drill-Through to SAP Table from the EPM tab of the ribbon. then select EPM > Drill-Through > Drill-Through to SAP Table and the name of the drill through. Example: The information that will be retrieved from the SAP table are the following: all the rows of the column called GROUP that contain AF and that do not start with the long name property for the current entity member cell.xml file.xml file. Enter FALSE to make the worksheet a Microsoft Excel standard one. This parameter is mandatory. Note: • • The source report can use a local connection or a Planning and Consolidation connection. Large Volume Data Sources • • • <VBAFunctionBeforeDrillThrough>: executes a VBA macro before executing the drill-through (for example: displaying a comment before the report). <VBAFunctionAfterDrillThrough>: executes a VBA macro after executing the drill-through (for example: applying formatting settings). <IsEPMSheet>: enter TRUE to make the destination worksheet an EPM worksheet. Enter the name of the macro. Enter FALSE to make the worksheet a Microsoft Excel standard one. 37 2013-09-04 . Enter the name of the macro. Large Volume Data Sources 38 2013-09-04 . • • Cell Context menu.1 Main Interface Areas The EPM add-in for Microsoft Office adds the following areas to Microsoft Office Excel. You can hide the bar by unchecking the Display EPM Context Bar option in EPM > Options > User Options. Only in Microsoft Office Excel. You can also move the bar into and back from the pane. explaining the command. The bar displays the dimensions that are included in the current cube/model and the members that are used in the currently displayed report (or the saved members in an offline report). Note: • • • • When positioning your cursor on a command in the EPM tab.About the EPM add-in Interface About the EPM add-in Interface 6. the page axis dimensions. using the mouse move pointer. The EPM pane is displayed by default vertically on the right side of the window. This bar can also be displayed inside the EPM pane by checking the Display Context inside EPM Pane option. a tooltip appears. You can hide the pane by unchecking the Display EPM Pane option in EPM > Options > User Options. The EPM Context bar is displayed by default horizontally and below the ribbon. the EPM tab does not contain all the same commands. information about the selected report. In Microsoft Office 2003. the name of the report. Note: The EPM Context bar and the EPM pane can both be hidden or displayed at the same time by clicking the Show Pane & Context button in the EPM tab. Microsoft Office Word and Microsoft Office PowerPoint: • In the ribbon of Microsoft Office 2007 and 2010. you can move the pane to the left side of the window or anywhere else in the window. Depending on the Microsoft Office application. the row axis dimensions and the column axis dimensions. the EPM menu is the main entry point for performing reporting and data input actions. This allows you to continue 39 2013-09-04 . Selecting the title bar of the pane and using drag and drop. all the dimensions available. The add-in adds a tab to the ribbon: EPM. including the connection used by the report. This pane includes the following areas: the active connection. a cell context menu appears when you right-click on any cell in the spreadsheet. the EPM tab is the main entry point for performing reporting and data input actions. • To move to the previous control. • The EPM tab can be accessed by pressing the Alt key and then pressing the character that is displayed on the EPM tab. check boxes. Once the menus are activated. • To select or deselect a check box. Then. the commands can be accessed by pressing the character that is displayed on the command you want to use. press the Tab key. if any. • To select another tab. press the Space bar. copy. paste and insert) and does not take up much space. • To move to the next control (list. • Context menus that require the right-mouse button can be displayed by using the Context Menu key (sometimes called the "exclusive" key). refer to the following table for the equivalent paths. Related Topics • Context • Report Creation using the EPM Pane • EPM Add-in for Microsoft Office Word and PowerPoint 6. 6. • To move between items in a list or in a group of options.About the EPM add-in Interface to use the existing Microsoft Office Excel features (such as: cut. use the right/left arrow keys. they can then be navigated using the arrow keys. • Inside a dialog box: • Press the Alt key to display the shorcuts on commands. • Inside the EPM tab. the bar and the dialog boxes. 40 2013-09-04 . press the up/down arrow keys.2 Performing Actions without the Mouse The EPM add-in menus and commands can be accessed without using the mouse. press the Esc key. If you use Microsoft Office 2003. • To close a dialog box or cancel a context menu. Persistent resizing You can resize the pane.3 Using Microsoft Office 2003 In the help documentation. press the Shift and Tab keys. Your resizing choices are kept from one session to the next. all the paths described in procedures apply to Microsoft Office 2007 and 2010. options). click the underlined letter. .About the EPM add-in Interface Caution: You cannot save a report with the . EPM tab in 2007 and 2010 EPM menu in 2003 Log On Open Save Edit Report New Report Report Actions > Delete Reports Report Actions > Copy Report Report Actions > Paste Report Report Actions > Worksheet Generation Log on icon button in the toolbar Reports > Open Reports > Save Reports > Edit report Reports > New report Reports > Delete Reports Reports > Copy Report Reports > Paste Report Reports > Worksheet Generation Report Actions > Manage Reports > Manage Connections Connections View Formats Refresh Expand Collapse Keep Exclude Back Save Data Planning Comments Journals Portal Publication Book Publication Distribution Quick Links Drill Through Reports > View Formats Reports > Refresh Data Analysis > Expand Data Analysis > Collapse Data Analysis > Keep Data Analysis > Exclude Back Data Input > Save [. Data Input > Spread. Data Input > Weight Data Input > Add Comment orData Input > Find Comments Data Input Collaboration > Portal Publication Collaboration > Book Publication Collaboration > Distribution Tools > Quick Links Tools > Drill Through 41 2013-09-04 .] Data Input > Trend..xlsx extension with Microsoft Office 2003. About the EPM add-in Interface EPM tab in 2007 and 2010 EPM menu in 2003 Offline Mode Insert Function Options More About Help Data Manager Tools > Offline Mode Tools > Insert Function Tools > Options Tools > More About About > Help Data Manager 42 2013-09-04 . when the feature described is not available or relevant to all cubes or models supported by the EPM add-in. Connection Depending on the connection you use. selectEPM > Options > Command Display Options. For example. the display of the EPM tab in the ribbon is initialized. Note: When installing the EPM add-in. When opening the add-in after the installation. • The task profiles that are assigned to you. depending on which report you select. To display or hide the commands or group of commands in the ribbon. For example. the Data Input group in the ribbon is not displayed since it is not relevant for this application. the commands available may change. For more information about task profiles. Related Topics • Introduction to the EPM Add-in • Logon and Connections 43 2013-09-04 . see the help documentation for the EPM application you use. you specify the applications you use. you can display the commands that are related to Planning and Consolidation. such as dialog boxes. If you want to use Planning and Consolidation at a later time. if you create on the same sheet several reports using different connections. if you specified the application Financial Consolidation during installation. a paragraph called "Applies to" specifies for which type(s) of connection the feature is available or relevant. depending on your selection in the installation setup. Task Profiles The features available also depend on the task profiles that have been assigned to you in the EPM application to which you are connected. some commands are automatically hidden or greyed out in the ribbon or in other interface sections.Features Available Features Available The EPM add-in features that are available depend on: • The connection you use. Note: In this documentation. Features Available 44 2013-09-04 . Security on Members Security on Members The security defined in the models or cubes you connect to is applied in the EPM add-in. For example. In a report. 45 2013-09-04 . if you retrieve data that you are not authorized to view. user 1 is not authorized to view any data on the Actual member. all the corresponding cells are left blank by default. Security on Members 46 2013-09-04 . A message is displayed after a refresh. xltx and xltm. uncheck the Keep Rows and Columns of Unrecognized Members option in the User Options. To do so. A dedicated dialog box automatically opens when needed. the formulas are also deleted. xlt. • Keep the unrecognized member rows. xlsm. In this case. if any. you need to manually remap these dimensions. Consequently. columns and formulas on data.1 Open a Report when Dimensions or Members have Changed When you open a report that contains dimensions or members that have changed since the last connection. 9. or work with a Planning and Consolidation connection. you can always use the Microsoft Office Excel. If you want to be warned that members are not recognized but will be kept. you can check the Warn if Rows and Columns of Unrecognized Members will be Kept option in the User Options. If you do not want to show the message again. you can choose between the following behaviors: • Do not keep the unrecognized member rows. depending on the connections you use. if any. Word or PowerPoint standard open and save features. you cannot open in Microsoft Office 2003 an xlsx or xltx workbook that has been created with Microsoft Office 2007 or 2010. If some of the members used in the report are not recognized as valid members in the cube or model (for example. the unrecognized members are automatically converted into "blank" members as soon as you perform a refresh of the report. To do so. check the Keep Rows and Columns of Unrecognized Members option in the User Options. you can open and save files in different ways. xlsx (except in Microsoft Office Excel 2003). you may have to perform the following actions: • Dimensions. Consequently. you can open or save files with the following formats: xls. Even if the Microsoft Office 2007 compatibility pack has been installed. In this case. you can specify that the columns and rows of unrecognized members are kept along with any formula entered in the data cells. select the option in the message box and click OK (clicking Cancel will not take into account the option selection) or uncheck the Warn if Rows and Columns 47 2013-09-04 . listing the members that are not recognized in the report.Open and Save a File Open and Save a File Using the EPM add-in. If some of the dimension names have changed. you can specify that the columns and rows for unrecognized members are automatically deleted as soon as you perform a refresh of the report. if formulas were entered in the data cells. Note: • • When using Microsoft Office Excel. a member has been deleted). • Members. columns and formulas on data. If you do not open a file from a web portal. In the BI launch pad tree structure of the Document List. You can also create an EPM workbook. displaying the EPM tab. 48 2013-09-04 . Note: A report structure (dimensions and members) may have changed in the following cases: • You open a report with the same connection with which the report was created. select the appropriate folder. you can publish an EPM workbook. Note: To insert a valid member instead of a blank member. see the SAP BusinessObjects Planning and Consolidation help. For more information on this feature. Note: When in Microsoft Office Excel. see Report Publication to a Web Portal. Open a file from Planning and Consolidation (web client) If you are using SAP BusinessObjects Planning and Consolidation. but some dimensions or members may have changed. see Member Entry Using the Insert Members Dialog Box. these two options are synchronized. Word or PowerPoint. New > EPM Document or New > EPM Presentation. displaying the EPM tab. For more information. Word or PowerPoint. you can open an existing EPM file from the BI launch pad. In the BI launch pad tree structure of the Document List.2 Open a File from a Web Portal You can open the EPM workbooks. document or presentation to the BI launch pad. 9. some dimensions or members may be different. documents or presentations from two different web portals. you can publish an EPM workbook. Even though the two data sources behind the connections have a similar structure. document or presentation from the BI launch pad.Open and Save a File of Unrecognized Members will be Kept option in the User Options. Word or PowerPoint. select one of the following: New > EPM Workbook. use the Insert Member feature. Word or PowerPoint. then double-click the file. For more information. you can open an existing EPM file from the Documents view. see Report Publication to a Web Portal. Open a file from the BI launch pad If you are using SAP BusinessObjects Enterprise. Note: When working in Microsoft Office Excel. document or presentation to the Planning and Consolidation Documents view. Depending on the type of file. For more information. • You open a report that has been created with a specific connection and you connect it to a different connection. A new file opens in Microsoft Office Excel. it opens in Microsoft Office Excel. input forms.1 Open and Save Connection Applies to: Planning and Consolidation connections Both Open and Save are performed on one specific connection. using the server folder structure. • Or select the connection from the Active Connection dropdown list of the EPM pane. you can use the Microsoft Office Excel standard open and save features. choose one of the following actions: • Select EPM > Open > Change Connection or EPM > Save > Change Connection. The dedicated features are:EPM > Open and EPM > Save. you can open and save documents containing reports. xlt. Note: The connection selected from the Active Connection dropdown list is automatically taken into account in the Change Connection dialog box. Here are the files that you can open and save: • Using Microsoft Office Excel. the connection on which Open and Save actions are performed is the connection that is currently displayed in the Active Connection of the EPM pane. you can open and save presentations containing reports.3. you can open or save files with the following formats: xls. xlsx (except in Microsoft Office Excel 2003). you can open and save workbooks containing: reports. then select the connection in the Change Connection dialog box. If you want to perform Open and Save actions on a different connection than the active connection. xlsm. Note: When using Microsoft Office Excel. 9.3 Open and Save a File for Planning and Consolidation Applies to: Planning and Consolidation connections If you use Planning and Consolidation connections.Open and Save a File 9. you can use dedicated features to open and save files. • Using Microsoft Office Word. By default. • Using Microsoft Office PowerPoint. Note: If you do not want to use the server folder structure. xltx and xltm. book publication templates and distribution templates. 49 2013-09-04 . • Server location for reports and input forms: you can open reports or input forms that are stored on the Planning and Consolidation server. none of the preceding two commands are available. the local "Reports" folder is selected by default in the dialog box that opens. book publication templates or distibution templates that are stored on the Planning and Consolidation server. • When you select Open my Input Forms. in dedicated folders: "Report" and "Input Schedules". the root folder is selected by default in the dialog box that opens. see Open and Save Dialog Box Description and Actions . the Company (Public) "Input Schedules" folder is selected by default in the dialog box that opens.2 Open Actions Applies to: Planning and Consolidation connections When you select EPM > Open. in dedicated folders. see Server Folder Structure. only the Open my Reports command is available. For more information about the folder structure on the server. Note: You can change the default local folder in the Open/Save Root Folder area of the User Options. • When you select Open my Reports. the Company (Public) "Reports" folder is selected by default in the dialog box that opens.3. Note: In Microsoft Office Word and PowerPoint.Open and Save a File 9. • When you select the Open Server Input Form Folder. • Server location for any file: you can open reports. different commands enable you to open a file from the following locations: • Local location for reports and input forms: you can open reports or input forms that are stored on your local machine in dedicated folders. • When you select the Open Server Report Folder. When you select the Open Server Root Folder. Note: • • For more information about the dialog box. the local "Input Schedules" folder is selected by default in the dialog box that opens. input forms. 50 2013-09-04 . Note: In Microsoft Office Word and PowerPoint. The Planning and Consolidation server folder structure is duplicated on your machine for two folders: "Reports" and "Input Schedules". The Planning and Consolidation server folder structure is duplicated on your machine for two folders: "Reports" and "Input Schedules". For more information about the folder structure on the server. the local "Reports" folder is selected by default in the dialog box that opens.Open and Save a File 9.3. You will then be able to use the report on other connections. in the Options tab of the Report Editor. the root folder is selected by default in the dialog box that opens. meaning without storing the environment or the model of the connection. Note: • • For more information about the dialog box. only the Save my Reports command is available. To do so. book publication templates or distibution templates on the Planning and Consolidation server. • When you select Save my Report. Note: You can change the default local folder in the Open/Save Root Folder area of the User Options. To do so. select the Do not Store Connection option. provided that the models have similar structures. select the Do not Store Environment in the Connection option. • Server location for any file: you can save reports. Note: In Microsoft Office Word and PowerPoint. 51 2013-09-04 . input forms. see Server Folder Structure. • When you select Save my Input Forms. Connection Information not Stored in the Report • You can save a report without storing the connection used to create the report. see Open and Save Dialog Box Description and Actions . When you select the Save to Server Root Folder. • You can also save a report without storing the environment of the connection used to create the report. in dedicated folders. different commands enable you to save a file to the following locations: • Local location for reports and input forms: you can save reports or input forms to your local machine in dedicated folders.3 Save Actions Applies to: Planning and Consolidation connections When you select EPM > Save. You will then be able to use the report on other connections using other environments. in the Options tab of the Report Editor. provided that the models' environments have similar structures. the local "Input Schedules" folder is selected by default in the dialog box that opens. you can create or delete a folder. the dialog box that opens can contain the following buttons on the left side. The folders are the same as for "Company (Public)".3. • • "Company (Public)". Inside this folder.3. the Do not Store Environment in the Connection option is greyed out. By right-clicking a folder in the middle part of the dialog box. 9. When opening or saving a file from or to the server. The folders and files displayed are the merge result of folders and files on your local machine and folders and files on the server for "Company (Public)". Inside this folder. 52 2013-09-04 . see Do not Store Connection and Do not Store Environment in the Connection. If you have access to a team. By right-clicking a file in the right part of the dialog box. delete or rename a file. • "Input Schedules": this folder contains input forms. and you can search for the name of a file. the Planning and Consolidation and Consolidation server folder structure is as follows: • Root folder • "Books": this folder contains book publication templates. you can copy. For more information. the folder "Templates" contains templates for input forms.4 Open and Save Dialog Box Description and Actions Applies to: Planning and Consolidation connections. a button with the name of the team is displayed. Note: You can change the default local folder in the Open/Save Root Folder area of the User Options. • "PDBooks": this folder contains distribution templates. 9. • "Reports": this folder contains reports. The folders and files displayed are the ones on the server.Open and Save a File Note: If you have already selected the Do not Store Connection option. the folder "Templates" contains templates for reports. depending on the rights you are granted: • "Local".5 Server Folder Structure Applies to: Planning and Consolidation connections For each model. "[team]". paste. see Launching the EvDRE Migration. Related Topics • Report and Input Form Templates 53 2013-09-04 . Note: Some folders appear only when corresponding files have been created. For more information.Open and Save a File • "Migration Copy": this folder contains original workbooks that have been migrated (only if the Do not move original workbooks in a different folder option is selected in the migration dialog box). Open and Save a File 54 2013-09-04 . then select Select Other Members. 55 2013-09-04 . The data displayed changes to reflect the new context settings. you automatically lock its dimension and you cannot select another member from the EPM Context bar: the dimension dropdown list is greyed out. • The members that are used in the current display of a report (or the saved members in an offline report). When you set a member. To change the context in a report: • You can select other members from the EPM Context bar. the context will be the same even if you have modified it in one of the workbooks. However. for each dimension of a selected cube/model. When the option is selected. Note: The members that are selected in the axes of a report override the members selected in the context. the name of the current model is displayed in the bar. the name of the dimension and the color are not displayed anymore in dropdown lists. You can alternatively display the context settings inside the EPM pane by selecting the Display Context inside EPM Pane option in the User Options dialog box. If you open other workbooks and connect to the same cube or model. select a dimension dropdown list. To select another member for a dimension. The Member Selector opens and you can make your selection. This option in not selected by default. you can set a specific member on a specific workbook or worksheet. a member corresponding to the default member to be applied for unspecified dimensions in any EPM function or in any report created. Note: If you set a member on a specific workbook. the member is also set on all the sheets of the workbook. Note: • • When using a Planning and Consolidation connection. Note that the dropdown lists are not case-sensitive. The context enables you to define. • You can also enter directly enter the complete ID of a dimension member in the EPM Context bar dropdown lists provided that the Enable Manual Entry of Members option is selected in the User Options. The context represents the following: • The dimensions that are included in the current cube/model.Context Context The context specifies the dimensions and associated members for a specific connection. The context is displayed in the dedicated EPM Context bar. The context applies to the user for a connection. then click the member and select the one you want from the Member Selector that opens. Note: You can set a workbook to refresh automatically upon selecting a member from the context by selecting the Automatic Refresh on Context Changes option in the User Options dialog box. Note: None of your modifications are saved until you click OK or if you click Cancel. enter a name in the dialog box that opens and click OK. • • 56 2013-09-04 . you can save the current context as a context favorite. enter a name in the Favorite list. To lock a dimension on a workbook or worksheet.1 Context Favorites If you frequently use the same context. instead of having to select each dimension member from the bar. In the Context Lock tab. Note: If the dropdown list is greyed out. The Lock checkbox is automatically checked for the dimension. you cannot select another member: this is because the dimension has been locked in the Context Options.Context • Alternatively. select EPM > Options > Context Options. Context Favorite Creation Here is how you can create a context favorite: • From EPM > Options > Context Favorites: • To create your first favorite. by using the context favorite dropdown list and selecting Save Current Context as Favorite. you can select a context favorite or save the current context as a context favorite (see Context Favorites). select the level from the dropdown list. modify the member selection. A context favorite is connection-specific. To create a favorite based on an existing one. You can then select the context favorite from the EPM Context bar. select Copy Favorite from the Favorite list. select New Favorite from the Favorite list. The members selected by default for the first favorite are the current context members. To create a new favorite. Finally. you can save it as a context favorite. • Directly from the EPM Context bar. You can change the member selection and click Create Favorite. select the existing favorite. 10. then enter a name in the dialog box that opens and click OK. You can also choose not to display the colors at all by unchecking the Show Dimension Color option. The order defined also applies to the other interface areas where the list of dimensions is displayed. Directly from the EPM Context bar. select the Hide checkbox. To display the dropdown list. Note: None of your modifications are saved until you click OK or if you click Cancel. the member selection is saved. To delete a favorite. For example. Dimension colors. You can define the colors you want for each dimension by clicking the colored area in the Color column. selecting the favorite from the Favorite list and click Rename Favorite. All these settings will be applied to the EPM Context bar. By default. In the EPM Context bar. you can select a context favorite. To do so. in the EPM Context bar. Context favorite display. Dimension order. • • • • 57 2013-09-04 . Other Actions on Context Favorites From EPM > Options > Context Favorites. the context favorite dedicated dropdown list is not displayed. you may want to hide it from the EPM Context bar. You can modify the default order of the dimensions as they appear in the EPM Context bar. you can uncheck the Show Dimension Name option. The checkbox is available in both the Context Display and Context Lock tabs.Context Context Favorite Selection The context favorite dropdown list is available in the EPM Context bar when the Show Context Favorites option is selected in the Context Display tab of the Context Options and even if you have not yet created a context favorite (see Context Display Options). Modify the member selection. You can choose not to display a dimension in the EPM Context bar. check the Show Context Favorites option. by selecting a dimension and clicking the Up or Down button. and to the current user. By default. colors are applied by default to all dimensions. When you click OK. select the favorite from the Favorite list and click Rename Favorite. To rename a favorite. • Hiding dimensions. such as the EPM pane and the Report Editor. The dropdown list is displayed even if you have not yet created a context favorite. select the favorite from the Favorite list. you can manage your context favorites: • • • To modify a favorite. Note: You can access the four features above in the Context Display tab. in the EPM Context bar. if you have locked a dimension on the worksheet. Dimension and member name display. You can specify if you want to display the list at the beggining or at the end of the bar by using the At Start and At End options. 10. the name of the dimension and the name of the member are displayed. If you want only the member name and not the dimension name to be displayed.2 Context Display Options You can specify display settings for the context by selecting EPM > Options > Context Options. The customized names are saved by user and connection. To remane a dimension. 58 2013-09-04 . The customized name you choose for a dimension overrides the other name of the dimension coming from the cube or model. enter the name you want in the Customized Name colonne of the Context Display tab. in any interface area of the EPM add-in.Context Renaming Dimensions You can define the name you want for any dimension. only the selected range needs to contain a valid layout of recognizable members. An axis is a set of one or more dimensions that define the row axis or column axis in a report (see the red and blue boxes in the layout picture above). Here is a sample report with the same highlighted borders to indicate all four sections. you can also request a refresh on ranges of selected cells. Notice that the three axes contain more than one dimension: 59 2013-09-04 . 11. The overall layout sections and terminology is as follows: Page axis members are members that act as a specification (filter) for the whole report. In addition.1 Overall Layout Rules This layout structure needs to be followed for each sheet that you refresh but can appear anywhere on the worksheet. These rules are simple and logical and also help ensure that your report is comprehensible to others. The data grid is where the amounts from the database appear. in those cases.Report Layout Rules Report Layout Rules There are some basic rules that you must follow in creating the layout of your report so that the EPM add-in can interpret it. and they are both recognizable members of the connected data source.1 Basic Layout Rules The compulsory items are the column axis and the row axis.forming the two axes. Here is an example of another valid minimal report: 60 2013-09-04 . The data returned by a refresh request will appear in the intersecting cell that appears towards the bottom-right (in this example: B4). 11.1. a report can be as small as this: Note that it does not matter where these two member cells appear on the worksheet.Report Layout Rules Note: Formatting and spacing is completely up to you. as long as the column header (in this example: Jan) is somewhere above and to the right of the row header (in this example: Revenue) . That is. For example. you need to have at least one dimension member in the row axis and one in the column axis . The following is an invalid report since it is impossible to determine if the whole report should contain data for Canada or for the USA: Note: You can.2 Dimension Layout Restrictions A dimension/hierarchy can only appear once in the whole layout. For example.1. The following reports are also invalid since there is no data that represents both January and April at the same time: The Period dimension appears both in the row and the column axis. perform a multi-selection of members for a dimension/hierarchy in the page axis. 61 2013-09-04 . a dimension/hierarchy in the row axis cannot have a member appear in the page axis or in the column axis or vice-versa. you cannot place two members of the same dimension/hierarchy in different cells.Report Layout Rules 11. Similarly. in a page axis. however. The Period dimension (Apr) appears in the page axis and in the column axis. You can see in this example that the page axis is above the column axis and that a row (in green) is inserted between the page axis and the column axis. When you select several members for a dimension that is part of the page axis. Related Topics • Overall Layout Rules 62 2013-09-04 .2 Page Axis The page axis define filters for the whole report. the data on the members are automatically aggregated in the report. You can select several dimension members for a page axis dimension. The page axis can appear anywhere as long as it is above the column axis.3 Row Axis The row axis defines the member row headers for a report. • • • The page axis is optional. meaning the labels that indicate what data should appear in each row. Related Topics • Overall Layout Rules 11.Report Layout Rules Related Topics • Page Axis Dimension Members Modification using the Member Selector 11. otherwise the page axis could be interpreted as the column axis. At least one row should be inserted between the page axis and the column axis. you add its members to the column immediately on the left. for example: 63 2013-09-04 . That is. 11. Note: If you type in the member names yourself. you can spread them out like this: This is useful if you need to put your own Microsoft Office Excel formulas or annotations in between the report lines. The EPM add-in will automatically correct the case and indent the members as specified in the sheet options.3.1 Simple Row Axis The simplest row axis you can have is member(s) from one dimension in one column like this: In this case we have Revenue.2 Multidimensional or Nested Row Axis To add an additional dimension to further qualify the row axis. COGS (Cost of Goods Sold) and GP (Gross Profit) which are all in the Accounts dimension.Report Layout Rules 11. you do not have to get the case or the indentation correct. You do not need to have them all in adjacent cells.3. For example: There is virtually no limit to the number of dimensions that you can nest together in an axis. There are now two dimensions in the row axis. They implicitly apply to all members on the inside dimension (such as Accounts above) until another member from their dimension appears.Report Layout Rules This is what is called a "nested" axis. if you really want the outer dimension members repeated explicitly. Chips. You do not have to repeat the product row headers on each line. However. the following color coded blocks define the data in the corresponding rows: Note: A "block" is basically a grouping of members. In the example above. For example. there are three blocks. Popcorn and Pretzels are all in the Product dimension. the following report has four dimensions in the row axis and is valid: 64 2013-09-04 . it is allowed and maintained if the relevant option is selected in the sheet options. The Accounts are nested inside of the Products. This is a common and logical reporting standard. For example. The first block is the first three rows in green color. Product and Accounts.3 Asymmetric Row Axis In the following report. Chips and Pretzels. The row spacing shown is completely optional. 65 2013-09-04 . and Revenue and COGS.Report Layout Rules The four dimensions from outside to inside are Currency. Reporting Unit. Related Topics • Repeat Row Headers and Repeat Column Headers 11. all of the inner dimension member lists are repeated in all occurrences: Canada and USA. This is called a symmetric report.3. Report Layout Rules An important feature of the EPM add-in is that the inside members do not have to be identical repeated sets of members. delete Microsoft Office Excel rows. 11. asymmetric expand or collapse.4 Row Axis Restrictions It is important to note that you must not leave members blank on the inside dimension like this: 66 2013-09-04 . The axis can be asymmetric like this: The products in each grouping above are not identical.3. but it is a valid report. This asymmetry is very common once you start using the following features: delete empty rows. 4 Column Axis The column axis defines the member column headers for a report. you must not put a blank column in between the nested dimensions like this: 11. The correct row axis for what the above report likely means is this: Note that the Accounts are now the outside dimension and the Products are now on the inside. This can be done by re-typing or moving the cells around. meaning the labels that indicate what data should appear in each column. Although you are allowed to put blank rows anywhere throughout the axis.Report Layout Rules Note: The formal definition of the nested dimension member rule is: all inner dimension members must be stated when an outer dimension contains a member on the same row. otherwise the page axis might be interpreted as the column axis. Related Topics • Overall Layout Rules • Page Axis 67 2013-09-04 . but it is usually much easier to use the Report Editor or the EPM pane and re-order the dimensions in the row axis section. This is called re-nesting the dimensions. Note: At least one row should be inserted between the page axis and the column axis. The Reporting ID is nested inside of the Months. if you want the outer dimensions to be centered over their inner dimensions. You do not need to have them all in adjacent cells.1 Simple Column Axis The simplest column axis you can have is member(s) from one dimension in one row like this: In this case.4. for example: This is called a "nested" axis.4. The first block is the first three columns in green color. They implicitly apply to all members on the inside dimension (such as Reporting ID above) until another member from their dimension appears. You can spread them out like this: This is useful if you need to put your own Microsoft Office Excel formulas or annotations in between the report columns. For example. the following color coded blocks define the data in the corresponding columns: Note: A "block" is basically a grouping of members. which are all in the Reporting ID dimension. 11. This is a very common and logical reporting standard. There are now two dimensions in the column axis. However. and Act2003.Report Layout Rules 11.2 Multidimensional or Nested Column Axis To add an additional dimension to further qualify the column axis. there are two blocks. we have Act2001 (Actual 2001). use Microsoft Office Excel's Merge and Center feature or Center across Selection like this: 68 2013-09-04 . you add its members to the row immediately above it. In the example above. Jan and Feb are both in the Period dimension. Note that you do not have to repeat the Period column headers in each column. Act2002. it is allowed and maintained. This is called a symmetric report. An important feature of the EPM add-in is that the inside members do not have to be identical repeated sets of members. For example: There is virtually no limit to the number of dimensions that you can nest together in an axis. the member name must be entered into the left-most merged cell. and Jan and Feb. 11. Account. and Period. Alternatively. if you really want the outer dimension members repeated explicitly.3 Asymmetric Column Axis In the following report. all of the inner dimension member lists are repeated in all occurrences: Revenue and COGS. the following report has four dimensions in the column axis and is valid: The four dimensions from outside to inside (top to bottom) are Reporting Unit. The axis can be asymmetric like this: 69 2013-09-04 . Act2001 and Act2002.4. Reporting ID. For example.Report Layout Rules Note: In merged cell column headers. This asymmetry is very common once you start using the following features: delete empty columns. The correct column axis for what the above report likely means is this: Note that the Reporting IDs are now the outside dimension and the Periods are now on the inside. delete Microsoft Office Excel columns. Although you are allowed to put blank columns anywhere throughout the axis. the data grid is displayed as the light-blue shaded area: 70 2013-09-04 . you must not put a blank row in between the nested dimensions like this: 11. In the following example. 11. A data grid cell will have a valid column axis above it and a valid row axis to the left of it. but it is a valid report. The data grid is the collection of cells that the application fills in with data from the OLAP data source.4 Column Axis Restrictions It is important to note that you must not leave members blank on the inside dimension like this: Note: The formal definition of the nested dimension member rule is: all inner dimension members must be stated when an outer dimension contains a member in the same column. asymmetric expand or collapse.4.Report Layout Rules The months in each grouping above are not identical. This can be done by re-typing or moving the cells around. but it is usually much easier to use the Report Editor or the EPM pane and re-order the dimensions in the column axis section.5 Data Grid Considerations The EPM add-in data grid is loosely defined as all cells that form the intersection of recognized database dimension member axis. This is called "re-nesting" the dimensions. Report Layout Rules However. 71 2013-09-04 . Note that the unusual text and background formatting is only used here to help you differentiate the areas of the report. The following example contains exactly the same data grid as above. the application offers a lot more flexibility than the above tight grid layout. There are many enhancements that you can make to and around the data grid to create a custom formatted report with additional calculations. but demonstrates several enhancements that will not prevent you from refreshing the report with the application. Note: If the Local Member Recognition is activated. it is recommended that you do all formatting last or apply dynamic formatting on the reports you want to analyze. Collapse or Keep) that will change the size of the report.1 Data Grid Important Tips Following are some important tips regarding the data grid: • Any number of blank rows or columns or both can be put anywhere throughout the grid.Report Layout Rules 11. It is recommended that you enter your custom formulas after you are finished doing ad-hoc manipulations to the layout and content.5. any Microsoft Office Excel formula is automatically converted into a local member. • You can format the cells any way that you want using Microsoft Office Excel formatting. • You can enter anything outside of the report area. In other words. they will not be retained if you perform a navigational action (such as Expand. It will be completely ignored by the application unless you expand your report. However. However. Your own Microsoft Office Excel formulas can safely be entered anywhere except in a grid cell and they will be retained in a subsequent Refresh. if you expand on or pivot your report. the formatting will not move with the cells. The changes are retained by the application. the grid can be split up. • Related Topics • Blank Row and Column Insertion • Dynamic Formatting • Local Members • Member Recognition 72 2013-09-04 . Therefore. including scaling the data. 1 Member Identification In the EPM add-in.Report Creation Report Creation You can create reports in four different ways: • Create reports using the EPM pane. The active connection is displayed in the Active Connection dropdown list of the EPM pane and in the Layout tab of the Report Editor. • Create reports using the Report Editor. A report is created by default on the active connection of the worksheet. • Create reports directly in a sheet.1 Member Identification and Properties 12. each member that is part of a report is identified by a formula beginning with =EP MOlapO. • Create reports using the Copy and Paste features.1. 73 2013-09-04 . Related Topics • Logon and Connections 12. the data on the members are automatically aggregated in the report. for example. Formula beginning with EPMLocalMember( Local member 12. Report creation by drag and drop in the pane In the Current Report area of the pane. when several members are selected for the same dimension.2 Member Properties You can display the properties of a selected member. Note: On a Planning and Consolidation connection. Note: • • If you work with several reports. then. by using the option Collapse Dimension Tree View in the User Options. 74 2013-09-04 . 12. This is optional. • Select a member in the Member Selector. then select EPM > More > Member Properties. • Row Axis. You can specify that the dimension tree view be collapsed. • Select a member in a report.1. In this case. you can view if the member is calculated or not. you can only create the first report using the pane. you must use the New Report button. you can drag and drop one or more dimensions to the following sections to create a report: • Page Axis. click Member Properties.2 Report Creation using the EPM Pane You can create and modify a report by using the EPM pane.Report Creation Member Formula Member (including custom member) Member identifying several members Formula beginning with =EPMOlapMemberO( Formula beginning with =EPMOlapMultiMemberO( Note: This type of member can only appear in the page axis of a report. To create additional reports. Alternatively to some of the above features.Report Creation • Column Axis. To enable manual update. you can switch to manual update. • The column axis by clicking the Move to Column Axis command.. By default.. you can reorder the dimensions if you have selected more than one dimension in an axis. By default the member taken into account for a dimension is the one defined in the context. the report layout is automatically updated. In the page axis section. by clicking the Move to Page Axis. select the cell you want in the sheet to move the page axis dimension. To do so. • Remove the dimension from the axis by clicking the Remove command. In the row and column axes sections only. • • Report creation by drag and drop in the worksheet You can drag and drop dimensions or hierarchies from the Current Report list directly to the worksheet to create a report: 75 2013-09-04 . Move to the Bottom and Move Down commands. select the cell you want in the sheet to move the page axis dimension. you cannot use the report until you switch back to automatic update. Using the Cell Selection dialog box that opens. you can perform the following actions: • In the dimension list section. The Member Selector opens and you can select the members you want. command. To improve performance when you are accessing a large amount of data. you can reorder the dimensions by selecting a dimension row (click on the right of the dimension link. not on the link itself) and performing a drag and drop. clicking the arrow that appears when you mouse over a member. you can quickly add. you can click on the cell reference of the dimension (D7 for example). the report with the selected dimensions is displayed in the worksheet. you can select another member for the dimension by clicking the dimension name that appears as a link. row and column axes sections. • Move the dimension to another axis. click Update to see the layout in the worksheet. In the page axis section only. • The row axis by clicking the Move to Row Axis command. When you finish changing the report layout. with the Member and Children relationship. • In the page. and then switch back to automatic update to see your results. Move Up. Move to Row Axis or Move to Column Axis command. When you switch to manual update. you can add the selected dimension to: • The page axis by clicking the Move to Page Axis command. each time that you make a change in the axes sections. select the Defer Layout Update option. move. Once a dimension has been added to an axis section. The Update button is enabled. Using the Cell Selection dialog box that opens. An error message appears if you have selected a cell that is below the column axis. and remove dimensions from the dimensions section to the axes sections. The Member Selector opens and you can select the member you want. The Defer Layout Update option is persistent.and provided that the Defer Layout Update option is not checked. using the arrow context menu (right-click). you can: • Select members for the selected dimension by clicking the Select Dimension Members command. you can click the Change Cell. However. When placing several dimensions in one axis. use the Move to the Top. As soon as you drag and drop at least one dimension in the row axis and one dimension in the column axis . For a local or SAP BusinessObjects Enterprise connection. It can be used to define other reports on a sheet already containing a report. exclude members from the report. you can also define specific options for the current report. Related Topics • Report Editor's Layout Tab Presentation • Several Reports in a Sheet 76 2013-09-04 . the member will also change in the report. Note: Using the other tabs of the Report Editor. filtering and ranking on the current report data. enter customized names for the members. The Report Editor performs a refresh after it closes since the report must be valid to close it. moving each page axis dimension individually. inserting a separation between axis and data. the context member is taken into account if the member belongs to the hierarchy you drag and drop. Therefore. The member that is selected in the context is displayed by default in the report. a member node that belongs to one hierarchy may not belong to another hierarchy. with the following relationship: Member Only. • You can perform all the above actions in the Layout tab of the Report Editor. with the following relationship: Member Only. or change the selection or order of members of one or more dimensions in the report. It can be used to define report position: moving a report in a sheet.Report Creation • • For a Planning and Consolidation connection. reorder the nesting of dimensions within an axis. It can be used at any time on a valid report to re-arrange the layout or change the members in each section of the report: move (pivot) one or more dimensions between the page headers. The context member or the default member is displayed by default in the report. You can access the Report Editor dialog box by clicking Edit Report in the ribbon. define sorting. it is the default member of the hierarchy (this is defined in the cube or model) that is taken into account. If the context member does not belong to the hierarchy you drag and drop. when you change a member in the EPM Context bar.3 Report Creation using the Report Editor The Report Editor dialog box plays several roles: • • • It can act as a graphic user interface for defining an initial report on a blank worksheet. When several hierarchies exist for a dimension. row axis and column axis. Related Topics • Several Reports in a Sheet 12. For this reason. The Member Selector opens and you can select the members you want. • Move the whole report by defining the position of the top left cell of the data grid. along with their hierarchies. you can add the selected dimension to: • The page axis by clicking the Move to Page Axis command. 77 2013-09-04 . On the left side is the Dimensions area which displays all the available dimensions. The Report Editor dialog box opens. you cannot include the default hierarchy anymore.Report Creation 12. On the right side. • • On the right side is an intuitive view of the dimensional layout of the report.3. click on Edit Report in the EPM tab of the ribbon. using the context menu (right-click) in the dimension list section and the three axes sections. you can dynamically modify your report at any time with actions such as pivoting. and remove a dimension from any axis area by dragging it back into the Dimensions area. Note: • If named sets are included in SSAS cubes created with Financial Consolidation Cube Designer. they will also appear along with the dimensions at the hierarchy level. • The column axis by clicking the Move to Column Axis command. by using the option Collapse Dimension Tree View in the User Options. you can also: • Define a shift between the data grid of the report and its row and column headers. When you click OK in the Report Editor. displaying the Layout tab by default. whereas the named sets appear in blue. the default hierarchy (flat list) automatically comes along. re-nesting (reordering dimensions within an axis) or changing the member selections. both the named set and the default hierarchy appear below the dimension in the Report Editor. • In the page. You can specify that the dimension tree view be collapsed. • Define the position of each dimension of the page header. once you have included the named set in the view. Note: Alternatively to some of the main features. and depending on the section you are in. row and column axes sections.1 Report Editor's Layout Tab Presentation To define or modify your report layout. • On the right side. the report is refreshed automatically. When a named set is created in SAP BusinessObjects Financial Consolidation. • The row axis by clicking the Move to Row Axis command. Note: Note that you can add an unused dimension in the Dimensions area to any section. you can: • Select members for the selected dimension by clicking the Select Dimension Members command. The hierarchies appear in black. Note that. As a consequence. you can perform the following actions: • In the dimension list section. cube designer. • • You can perform drag and drop operations between the three axes and the Dimensions areas. In the page axis section only. simply drag and drop your required dimensions to the correct sections of the report. This applies to the column axis also. you can order the dimensions if you have selected more than one dimension in an axes. drag it to the Dimensions area. it will default to the cell on the right side of the page axis that you drop it under. by clicking the Move to Page Axis. command. In the Dimensions area. • In the row and column axes sections only. This includes moving the dimension name from one section to another or changing the order of the dimensions within a section. Dimensions that are not already in the report can be dragged into the layout from there. you can click the Change Cell. If you add a dimension to the page axis section. select the cell you want in the sheet to move the page axis dimension.Family Product Before Account Row Axis Dimensions: Product. click Reset Report. To remove all dimensions from the layout. row axis and column axis. Remove the dimension from the axis by clicking the Remove command. To remove a dimension from the layout. To define your layout. reorder the nesting of dimensions within an axis. Move to the Bottom and Move Down commands. Move to Row Axis or Move to Column Axis command. Account Before Product Row Axis Dimensions: Account Product.Family Account 78 2013-09-04 .3. 12. the dimensions and hierarchies with a red cross indicate that they already appear in the report. use the Move to the Top. or change the selection or order of members of one or more dimensions in the report.2 Dimension Placement in the Report Editor You can use the Report Editor at any time on a valid report to re-arrange the layout or change the members in each section of the report: move (pivot) one or more dimensions between the page axis.. Example: In the following example you can see the effect of the order of the dimensions in an axis.. Using the Cell Selection dialog box that opens. Move Up. To do so.Report Creation • • • Move the dimension to another axis. Note: • You can also select the members directly on a spreadsheet in a valid report by double-clicking on a dimension of the page axis. the data on the members are automatically aggregated in the report.Report Creation Account Before Product Product Before Account 12. This allows you to quickly change the page axis members. To modify the member selection for a dimension in the Page Axis Dimensions area. The Member Selector opens and you can select the members you want. The Member Selector opens and you can select the members you want. click on the dimension name. • • Related Topics • Member Selection • Page Axis Dimension Members Modification using the Member Selector 79 2013-09-04 . it is recommended that you convert the selection into a custom member. click on the dimension or on the member name.3. If you often use a specific selection of members for a page axis dimension. When you select several members for a dimension that is part of the page axis. When you click OK in the Member Selector. the report is refreshed automatically. You can do the following" • To modify the member selection for a dimension in the Row Axis Dimensions area or the Column Axis Dimensions area.3 Member Selection in the Report Editor You can select the members to be displayed in the report directly from the Report Editor. Example: • • If you enter 2 in the Shift area below the column axis area. Note: You can enter negative numbers for the row axis. as soon as you click OK.3. You can change it by entering the cell reference or using the arrow buttons. An error message appears if you have selected a cell that is below the column axis. If you leave 1 by default in the Shift area on the right of the row axis area.3.6 Shift Insertion Between the Data Grid of the Report and its Row and Column Axis Using the Report Editor.Report Creation 12. 12. 80 2013-09-04 . The column axis. You can position a page axis dimension anywhere as long as it is above the column axis In the page axis area of the Report Editor. The cell displayed by default in the middle of the four blue arrow buttons in the Report Editor. one column will be inserted between the data grid and the column axis.4 Position of each Dimension in the Page Axis using the Report Editor Each dimension in the page axis can be positioned individually.3. In this case. use the Shift area. corresponds to the top left cell of the data grid (B22 for example). The whole report is moved based on this cell. click on the cell reference of the dimension (D7 for example). no row will separate the data grid from the row axis. the row axis will be positioned on the right side of the data grid. Using the Cell Selection dialog box that opens.5 Report Move in the Sheet using the Report Editor You can move a report in the sheet simply by choosing one cell in the Report Editor. 12. you can insert a separation between the data grid and: • • The row axis. To do so. select the cell you want in the sheet to move the page axis dimension. You can also enter Microsoft Office Excel formulas. a green flash briefly appears in the cell. If you correctly enter the complete dimension member name. You can enter a complete dimension member name or just a part of it. If you have not activated the Member Recognition. The Member Recognition features can be activated or deactivated by sheet or for all sheets.1 Member Entry Directly in a Sheet Instead of using the Report Editor dialog box. The Member Recognition feature must be activated.1. you use the Member Recognition and the Local Member Recognition features.4 Report Creation Directly in a Sheet You can create a report manually. you can enter text and figures directly in the cells of a sheet if you know the names of the members you want to retrieve. the Microsoft Office Excel formulas are automatically converted into local members.Report Creation 12. • Using the Insert Members dialog box that you access by right-clicking in the row or columns axis of a report. you can also get assistance to select members: • Using the Member Selector that you access through the Report Editor. When you manually create a report. You can enter dimension members and create local members directly in a cell of a report. indicating that the member has been recognized. as soon as you press the Enter key.4. When you enter a part of a dimension member name: • If the member name fragment is unique in the cube. indicating that the member has been recognized. the members are automatically recognized. you can launch it on an ad-hoc basis at any time. the name is automatically completed and a green flash briefly appears in the cell. When the Member Recognition feature is activated. 12. the EPM pane or by double-clicking a member located in the report page axis. When the Local Member Recognition feature is activated. 81 2013-09-04 .1 Member Recognition You can enter members directly in a cell of a report. as soon as you press the Enter key. 12.4. To do so. You can also use the Auto Fill feature to automatically fill in cells with all the members of the same level in the hierarchy order. Note that a row or column is inserted at a fixed location (cells 6B for example).4.2 Blank Row and Column Insertion In a report. the report loses its dynamicity and therefore becomes a static report. the inserted row or column remains.Report Creation • If the member name fragment is not sufficient to identify the member. a text or to be used as a separation row or column. To create a blank member.and provided that the Apply Specific Formatting to Unrecognized Members user option is selected. When you select a member in the sheet. If you do not select any member in the dialog box and close it . see Blank Row and Column Insertion. If the member is unique. You can modify the settings of the style by clicking the Edit button next to the option: the Microsoft Excel standard Style dialog box opens. The formatting is a standard Microsoft Excel style called EPMUnrecognizedMember. enter blank in a cell of a report and press the Enter key. displaying all the members contained in the cube that might match the entered member. For more information about blank members. • 12.3 Microsoft Office Excel Formula Entry Directly in a Sheet 82 2013-09-04 . you should create a local member. you can insert a Microsoft Office Excel blank row or column to add a formula.1. the Ambiguous Name dialog box opens. entering blank directly in a cell of a report or using the Selection Relationship area of the Member Selector. For example. it is converted into a member and the link will be kept inside the formula. In this case. This allows you to create reporting templates where you can change "Ohio" to say "New York" in one place and then update (Refresh) all the related reports to get "New York" data. Note: • • The recognized members are uniquely identified.1.4. the cell in which you have entered the member name is applied a specific formatting to indicate that the member is not recognized. You can define a member based on a formula. Related Topics • Local Members • Selection Relationship 12. • If you want a blank row or column to be specifically attached to a member for example. the Microsoft Office Excel Formula bar displays: = EPMOlapMemberO(xxx). • You can also create a blank member that behaves like any standard member. When you perform a refresh of the report. you can have "=Sheet2!D4" picking up the value "Ohio" from another worksheet. here is an example of what you get: You want to display the five members that come before France Eau in the hierarchy. the standard Microsoft Office Excel Auto Fill feature enables you to automatically fill in cells with all the members of the same level in the hierarchy order. Example: In your report. You want to display same level members for France Eau.Report Creation You can use Microsoft Office Excel formulas to perform calculations.4. only France Eau is displayed. Related Topics • Blank Row and Column Insertion • Local Members 12. By selecting the France Eau cell and dragging the pointer (in the lower right corner of the cell) to cover the three following cells. By selecting France Eau cell and dragging the pointer (in the lower right corner of the cell) to cover the five cells above.4 Auto Fill When the Member Recognition feature is activated. You want to display the three members that come after France Eau in the hierarchy.1. here is an example of what you get: 83 2013-09-04 . All Microsoft Office Excel formulas are automatically converted into local members. 1. Example: Auto completion in a nested axis In the row axis. 84 2013-09-04 . as shown in this example. You have already entered the following members: 2008 EUR USD Now. Note: If you want to apply your selection to any new worksheet that will be created.6 Activating or Deactivating the Member Recognition Options 1.4. 2. you enter the Period member 2009.5 Auto Completion in Nested Axes When a row or a column axis contains several dimensions (nested dimensions). click the Save as Default button.4. members in the inner dimension are automatically entered. when entering a member for example in the outer dimension. Select EPM > Options > Sheet Options. To activate or deactivate the Member Recognition or the Local Member Recognition to be applied to the current sheet. the outer dimension is Period and the inner dimension is Currency. provided that the Member Recognition is activated.Report Creation 12. you can select or deselect the Activate Member Recognition or the Activate Local Member Recognition option.1. The member is recognized as an EPM member and the Period members EUR and USD are automatically entered: 2008 EUR USD 2009 EUR USD 12. Note: When displaying the members in a list. you can display the members in a simple list or in the hierarchy in the Dimension Members area. the EPM pane or by double-clicking a member located in the report page axis. then select Refresh > Launch Member Recognition. enter your search text into the Find What text box and then click on the Find button. Member filtering by properties. the name of the dimension/hierarchy is displayed. you can get assistance from the Member Selector dialog box which allows you to select any dimension members to help you construct your report layout. Note: • The search is not case-sensitive (for example: "Shares" and "shares" will be treated the same). To help you select members. • • • Member names to display. 12.4. 2. depending on what has been defined in the cube or model. You can search for a specific member.4. you can click the Member Name header and the members are sorted by ascending/descending order. The Member Selector is composed of the following areas: • • In the title bar.7 Launching Member Recognition If you have not activated the Member Recognition.Report Creation 12. Using the dropdown list.2.1 Member Selector Presentation The Member Selector can be accessed through the Report Editor. To launch the Member Recognition on the current worksheet. select a range of cells. Use the list icon. Hierarchy or list display.4.2 Member Entry Using the Member Selector When you manually create or modify a report. 85 2013-09-04 . 12. select Refresh > Launch Member Recognition. you can launch it on an ad-hoc basis at any time. To launch the Member Recognition on specific cells. Using the binoculars icon.1. 1. You can choose other member names to display as alternatives to the captions. Member search. you can filter the members by property value. if you choose to keep the context member selection in your report. When several hierarchies exist for a • 86 2013-09-04 . It will expand and scroll the tree to display each member found. You can display the properties of a selected member. Member Sorting & Grouping button. Dimension Members list.2. It searches through all members. It is where you select and order the members of the currently selected dimension that you want to appear in the report. Selected Members area. The member tree can be expanded by clicking the + icon. It will tell you when it reaches the bottom and ask you if you want to restart at the top. not just the visible ones. and contracted by using the . For some dynamic relationships. It allows you to select many members at once based on their relationship to selected (checked) members. If you have entered a customized name for a member. • • • • Buttons to select members. the member will also change in the report. Member Properties. when you open the Member Selector. You can sort and group the selected members based on property values. Related Topics • Renaming Members 12. a member is selected by default. you can define the levels of the hierarchy you want to display. • For a Planning and Consolidation connection: the member that is selected in the context is selected by default in the Member Selector. they appear in the Dimension Members list.Report Creation • • • • • • • • • You do not need the full member name (see "shares" example in the picture above").2 Member Selection • Even if you have not selected a member to display in the report. when you change a member in the EPM Context bar. Selection Relationship drop-down list. Therefore. it appears in this list.icon as necessary to view and select members.4. This list contains all the members of the current dimension. For a local or SAP BusinessObjects Enterprise conection: the context member or the default member is selected by default in the Member Selector. Note: • • If you have created custom members for a specific dimension. Hierarchy Levels options. It starts from the selected (highlighted) member and goes down. with the following relationship: Member and Children. It will tell you if there are no occurrences at all. You can select the & operator (=AND). The arrow to the left button will remove the selected members from the Selected Members list. 87 2013-09-04 . to the bottom of the selected members list. order it as it will appear in the report. Then add it to your member selection by using the right arrow button. you can create and insert a blank member for the current dimension. so that only the members at the intersection of the different items are displayed.4. Note: The arrow to the right button will copy the checked members. • Members can be added to (or removed from) the Selected Members list using the right and left arrow buttons to add or remove the selection made in the Dimension Members list.2. • When selecting several items (members or filters by properties). Note: Since it behaves like a standard member. a blank member is dynamic and moves as you navigate in a report. totals and sub-totals appear at the bottom. and select Blank Member from the Selection Relationship dropdown list. all the items will be displayed in the report: the + operator (=OR) is applied by default when you add an item in the Selected Members area.Report Creation dimension. by default. For this reason. The & operator takes precedence over the + operator. When you open the Member Selector. do not select any member in the Dimension Members area. the context member is taken into account if the member belongs to the current hierarchy. This member behaves like any other standard member. a member node that belongs to one hierarchy may not belong to another hierarchy. This is because in most reporting situations. Use the Ctrl or Shift keys to select multiple members like in any standard Microsoft list. it is the default member of the hierarchy (this is defined in the cube or model) that is taken into account. Related Topics • Context • 12. If the context member does not belong to the current hierarchy.3 Blank Member Using the Member Selector. Once the blank member is displayed in the Selected Members area. You can also delete member(s) by selecting them and then pressing the Delete key. Colors indicate how the items are combined. and any related members depending on the Selection Relationship choice. Note: The parents of members default to the bottom of their children on the Selected Members list. Note: Alternatively. you can also drag and drop a selected member or members within the list to reorder them. You can reorder the members in the list by selecting one or more of the members and then using the reorder buttons. 4. Key-Caption. depending on your data source. description.4 Member Name to Display You can choose other member names to display as alternatives to the captions. • Planning and Consolidation connections: ID.xml file located in the EPM add-in installation folder.2. depending on what is defined in the ProviderCapabilityConfiguration. depending on what has been defined in the cube or model. • Profitability and Cost Management: only the captions are available. If the properties exist in the dimensions. You can select the names to display from the dropdown list next to hierarchy/list dropdown list. Example: To be able to display the member name Description-ID. you can also enter blank directly in a cell of a report. you can customize the member names you want. extra-long description. If you want a blank row or column to be specifically attached to a member. the member name is taken into account in the report. for example.Report Creation • • • You can insert a Microsoft Office Excel blank row or column. the concatenated names are available for selection in the display name list in the Member Selector.xml file: <CustomProperties> <CustomProperty Name="Description-ID" Description="" > <Property Name="EpmDescription"/> <Property Name="EpmID"/> </CustomProperty> </CustomProperties> 88 2013-09-04 . To create a blank member. ID-description. but the row or column will be fixed (cells 6B for example). • Specific to large volume data sources: for SAP NetWeaver BW InfoCube using a local connection. you should create a local member. enter the following in the ProviderCapabilityConfiguration. Related Topics • Blank Row and Column Insertion • Local Members 12. Key-Medium Name. When selected in the Member Selector. Properties and attributes can also be available. You can modify the combination names. • For Planning and Consolidation connections. You can choose other member names to display. you can add other names. Key-long Name. The following items are available depending on the connection and the application: • Local and SAP BusinessObjects connections: • Financial Consolidation: code. In this file. the following name combinations are provided in the file: Key-Name. short description. based on properties. long description. Report Creation EPMID stands for the ID of the member; EPMDescription stands for the description of the member. Note: • If the properties exist in the dimensions, the concatenated names are available for selection in the display name list in the Member Selector. If one of the properties does not exist, the name is not available for selection. The member names are defined, regardless of the dimensions. If the name is not applicable for a dimension, the name is not available for selection in the Member Selector. The member names are defined by user. • • Related Topics • Display Name • Large Volume Data Sources 12.4.2.5 Selection Relationship The Selection Relationship list allows you to automatically select members based on their relationship to the selected (checked) members in the Dimension Members List. This can save you a lot of time. For example, you may want all the children of a specific member or members, or you may want the member and all its ascendants. If you select the Dynamic option (selected by default), each time you perform a refresh on the report, the report will automatically pick up new members or remove members that have been deleted from the cube or model. The following list shows the supported relationships. Note: The first time you open the Member Selector, the default relationship is Member and Children. The selection you then make is persistent: the next time you open the Member Selector, the relationship selected by default will be the last one you have selected. • • • • • • • • • • • Member Only Member and Children Children Member and Descendants Descendants Base Level Same Level Siblings Member and Ascendants Ascendants Member and Base Level 89 2013-09-04 Report Creation • Member Offset When selected, the Member Offset area is displayed. This feature enables you to display a member related to another member by specifying an offset from a given member to retrieve the previous or subsequent member. You can also specify a hierarchy level. By default (Member Level option), the member at the same level as the member specified is incremented. You can also choose a specific level. Note: When you choose a specific level using the Level option, note that only the members that are above the selected member or at the same level in the hierarchy, will be displayed. If you specify a level that is below the selected member, the level will be ignored. See the second example below. • • Example with the Member Level option: you select 2009.Q1 in the list of dimensions and you specify an offset of 2. The 2009.Q3 member will be displayed in the report. Example with the Level option: you select Quarter 1 in the list of dimensions, then you specify an offset of 3, then you specify the level 2. The member displayed in the report will be the third member (increment based on member Quarter 1) at the same level of Quarter 1: Quarter 4. Since the second level of the hierarchy is below Quarter 1 level in the hierarchy, the level is therefore ignored. • Member Property When selected, the Member Property area is displayed and enables you to select a property. This feature enables you to display the property value of the selected member, that is another member of the same dimension. For example, you check the member ACTUAL, then select Member Property from the Selection Relationship list, then select the COMPARISON property. In your report, the member BUDGET is displayed, as this is the comparison value for the ACTUAL member. If there is no property value for a member, the member is retrieved in the report cell. • Dimension Property You can select Dimension Property when there are two dimensions in the current axis (row or column axis) and when you do not select any member in the Dimension Members area of the Member Selector. Once Dimension Property is selected, the Dimension Property area is displayed and enables you to select a dimension and a property for the dimension. This feature displays the property values for the displayed members of a dimension, based on another dimension's members. If no property value exists, the context member of the dimension is displayed in the report. For example, the row axis contains the two dimensions Entities and Reporting Currency. Open the Member Selector for the Reporting Currency dimension: select Dimension Property from the Selection Relationship list, then select the Entity dimension and the CURRENCY property. In your report, here is what is displayed: first column lists USA and France; the second column lists USD and EUR. Note: For some relationships (relationships including ascendants, descendants and base level), you can define the levels of the hierarchy you want to display in the report, using the Hierarchy Levels area. Using the Selection Relationship list, you can also create a blank member. This member behaves like any other member. Blank Member 90 2013-09-04 Report Creation Note: When no member is selected, the relationships available are: All Members, Base Level, Blank Member and Dimension Property. Related Topics • Hierarchy Levels to Display 12.4.2.6 Hierarchy Levels to Display For some relationships (relationships including ascendants, descendants and base level), you can define the levels of the hierarchy you want to display in the report: • • By default, all the levels of the hierarchy are displayed and the All Levels option is selected. You can select the number of levels you want to display, keeping in mind that level 1 is the highest level of the hierarchy. If you select 3, levels 1, 2 and 3 will be displayed in the report.Use the Number of Levels option. You can also select only one level to display. Use the Only Level option. • 12.4.2.7 Member Sorting and Grouping by Properties You can sort the selected members based on property values. To do so, click the Member Sorting and Grouping button and select the Enable Member Sorting options. You can perform the following actions: • Sort the members based on their names, by ascending or descending order. If the members are organized in a hierarchy, the members are sorted and therefore the hierarchy may be broken. To do so, use the Ascending or Descending options. • Additionally, you can sort the members based on a property, in ascending or descending order, depending on the option you have selected. The values of the specified property are ordered by ascending or descending order. Inside each node, the members are sorted in ascending or descending order. To do so, select the Group by Property option, then select a property from the dropdown list. • Create a grouping local member in the dimension based on the property selected for the sorting. To do so, follow these steps: • To position the local member before the set of members (or property group), select the Before Group tab. To position the local member after the set of members (or property group), select the After Group tab. • In the Create a Local Member Named area, enter a name for the grouping local member (or leave the dafault name). This name is not displayed in the report but in the Local Member 91 2013-09-04 Report Creation • Selection tab when defining a specific format for the local member. For more information on how to define a format for a local member, see Dynamic Formatting Template Definition. In the Display area, you can enter the name for each grouping local member that will be displayed in the report. This name can be either static or dynamic, that is containing the property value or the property value description (can be selected from the dropdown list), a prefix and a sufix. Example: For the Currency dimension, property values are EUR and USD; property value descriptions are Euro and US Dollar. Note: If a property value description cannot be displayed, the property value is displayed instead. • You can then define the calculation to be performed for the grouping local member. The calculation is performed the same way as for local members. If you do not enter anything in the Formula area, total and sub-total calculations will be performed for a hierarchy. Note: When using the Member Sorting and Grouping feature and also sorting data in a report, the sort on data takes precedence over the member sorting and grouping. Example: Entities grouped by country In this example, a grouping local member has been created for the Entities dimension, based on the Country property. All the entities are grouped under the country to which they belong. The following items are specified in the Member Sorting and Grouping area of the Member Selector: the Ascending order option is selected, the Country property is selected in the Group by Property dropdown list; in the Display area of the Before Group tab, the entered prefix is "Country: " and the Property Value is selected from the dropdown list. No formula is entered. Therefore, sub-total calculations are performed on the countries. Related Topics • Local Members 92 2013-09-04 Report Creation 12.4.2.8 Member Filtering by Properties You can filter the members by property. To do so, click the filter icon in the Member Selector and define the filter(s) in the Member Filtering by Properties area that appears. • To define a filter, select one of the properties available for current dimension/hierarchy using the Property dropdown list. Then select an operator and property values: • =: equal. • • For example, to filter all the entities that belong to the France value for the Country property: Country=France. For example, to filter all the entities for which the currency is the context member of the Currency dimension. In the filtering area, select the following information: Currency = <CONTEXT> Currency For example, to filter all the entities except the ones that belong to the France value for the Country property: Country<>France. For example, to filter all the entities except the ones for which the currency is the context member of the Currency dimension. In the filtering area, select the following information: Currency <> <CONTEXT> Currency • <>: not equal. • • • • • LIKE: equals the entered value. You can enter text or figures and use the * character before or after the entered value. For example, to filter the chart of accounts beginning with "10", enter "10*": Chart of Accounts LIKE 10*. BT: range between a low and high value. For example, to filter the chart of accounts for values between 1000 and 1100: Chart of Accounts BT 1000 1100. The Dimension Members area displays only the members that meet the filter criteria because the Display Only Filtered Members option is selected by default. Note: When the Display Only Filtered Members option is selected, the members appear in a list; they no longer appear in a hierarchy. Therefore, the dropdown list on the top left corner of the dialog box automatically displays List. If you deselect the option, all the members for the current dimension/hierarchy are displayed in a hierarchy, and the dropdown list on the top left corner of the dialog box automatically displays Hierarchy. • To make a selection, you can do one of the following: • Check the members you want and click the right arrow button. The checked members, and any related members depending on the Selection Relationship choice, are moved to the bottom of the selected members list. 93 2013-09-04 Report Creation • Select the filter itself. The filter is dynamic, meaning for example that if a member with a specified property is created in the cube or model, it will be added automatically to the report. To select the filter itself, click the Add Dynamic Filter button. Note: • • • You can define criteria for a filter. For example, all the entities that have the "Euro" property value and all the ones that have the "USD" property value. If you define several criteria using the same property, the operator OR is used between each criterion. If you define several criteria using different properties, the operator AND is used between each criterion. 12.4.2.9 Page Axis Dimension Members Modification using the Member Selector You can modify the members for a dimension in the page axis directly from the sheet. To do so, double-click the member cell. The Member Selector that opens is a sub-section of the one opened from the Report Editor or the EPM pane. However, this Member Selector includes an additional option called Allow Multi-Selection. Using this option, you can select several dimension members for a page axis dimension. When you select several members, the data on the members is automatically aggregated in the report. When the Allow Multi-Selection option is selected, the Select all Members option is enabled: you can use it to select in one single click, all the members that are in the list of members of the Member Selector. Note: • • • You cannot select more than 30 members. If you often use a specific selection of members for a page axis dimension, it is recommended that you convert the selection into a custom member. You can display the members in a hierarchy or a list, you can select the member names to display in the report, and you can search for a specific member. Member Parent Quick Selection in Page Axis To quickly select the parent member of a member located in the page axis of a report, select the member cell, then click Collapse in the EPM tab: the parent member is displayed instead and is taken into account in the report. This is possible only when a single member is selected for a dimension located in the page axis. Related Topics • Member Selector Presentation • Custom Members 94 2013-09-04 Report Creation 12.4.3 Member Entry Using the Member Selector (on Large Volume Data Sources) When you connect to a data source that has a large volume of members and you have selected the Do not Load Members at Connection option for the connection, the Member Selector is consequently designed differently. The following paragraphs describe the differences between the standard Member Selector and the Member Selector used for large volume data sources. Hierarchy or Find Result display Using the dropdown list in the top-left corner of the dialog box, you can only display the members in a hierarchy, not in a simple list. In addition, you can also display the members that result from the search that you previously performed using the binoculars icon. Filter by Properties When you click Filter by Properties, a dedicated dialog box opens. For a BW data source, LIKE is not available in the dropdown lists. To use the context member value as a property, you must enter <CONTEXT> and the name of the dimension as it appears in the EPM Context bar. For more information on filtering by properties, see Member Filtering by Properties. Find What In the Find What area that opens when you click the binoculars icon: • for a BW data source: • The Match Case option is selected and greyed out. • The Find Whole Words Only option is not selected and is greyed out. • You can restrict the search to the members and descendants of one or more members, that you select in the tree view on the left side of the Member Selector. Each member you select in the tree view is displayed in the Find What area. • The search is performed on member captions only. for an SSAS data source: • The Match Case option is not selected and is greyed out. • The Find Whole Words Only option is not selected and is greyed out. • The search is performed on the name selected in the Display menu, or by default on captions. • You can view the result whenever you want by clicking Find. For more information on the Find feature, see Member Selector Presentation. 95 2013-09-04 Report Creation Relationships not contextual to a specific member When clicking the last button on the right in the top part of the dialog box, the relationships available are: Select all Members, Select Base Level, Insert Blank Member. Also, Dimension Property is not available. For more information about relationships, see Selection Relationship. Member Properties You can display the properties of a selected member by clicking the last icon in the upper part of the Member Selector. Members available for the Dimension In the list of members available for the current dimension, as members are loaded when you select a node, some elements are slightly different than in the standard Member Selector. • • • • For each node, the number of children is displayed, whereas the number of descendants are displayed in the standard Member Selector. To select a member, click on it: a tick icon is displayed. When selecting members, each member selected is displayed at the bottom of the dialog box. To remove a member from the selection, click on it and the tick icon disappears. You can specify the maximum numbers of members that should be loaded and displayed when you expand a node. To do so, use the user option Members Displayed on Node Expansion in Member Selector. By default, a maximum of 1000 members are loaded and displayed. For performances reason, you may want to load a smaller amount of members on node expansion. Selection Relationship In Members, all the members selected in the list of members are displayed. In Relationship, you select the relationship that applies to all the selected members. Note: The Member Property relationship does not exist. Regardless of the relationship you select, the relationship is applied default settings that you can view and modify in the Selection Relationship Options dialog box by clicking the Options link. For example, this is where you can modify the hierarchy levels to display when selecting Member and Descendants. For more information on hierarchy levels, see Hierarchy Levels to Display. To take into account your selection, click the Add Members button. For more information on relationships, see Selection Relationship. Selected Members In the right section of the dialog box, the members you have selected are listed. • • • You can edit a member selection by clicking the Edit icon to the right. The Selection Relationship Options dialog box opens and you can make changes. You can re-order the members using the arrow buttons on the right side. You can remove a member selection by clicking the red cross on the right side. 96 2013-09-04 Report Creation • • When selecting several members, by default, all the members will be displayed in the report (meaning OR is applied by default). To display only the members at the intersection of the different members (meaning AND), you can merge the members by selecting several members and clicking the Merge Members icon on the right side. Once members are merged, you can unmerge the members or remove a member from the merge. Member sorting and grouping by properties. You can sort the selected members based on property values by clicking the last icon on the right side. For more information about member sorting and grouping by properties, see Member Sorting and Grouping by Properties. For more information about selected members, see Member Selection. Related Topics • Large Volume Data Sources 12.4.4 Member Entry Using the Insert Members Dialog Box You can insert members for the dimensions that are in the row or column axis of the current report. To do so, right-click in a cell that belongs to the row or the column axis and select EPM > Insert Members. The Insert Members dialog box displays the dimensions that are in the axis you are on. For each dimension, you can select the members you want to add to the report: select a dimension, then click Select Members. The Member Selector opens. If a filter has been previously defined to restrict the member insertion on the dimension, the Member Selector enables you to select only the filtered members. For more information, see Member Insertion Filtering. You can specify where in the axis you want to insert the selected members: at the selected cell or at the end of the axis. If you have specified that you want to insert the members at the selected cell, you can also specify: • if you want to insert the members and move down accordingly the members below in the axis, • or if you want the selected members to replace the current members. Example: you have selected two members to insert, the axis contains four members and the cell selected when performing the right-click is the second member cell. The second and third members in the axis will be replaced by the two selected members. Note: • • The selection you make is persistent: the next time you open the Insert Members dialog box, the default options are the ones you selected previously. Empty rows and columns behavior for inserted members. You have selected the Remove Empty option for rows or columns in the Sheet Options. You then insert members using the Insert Members dialog box. Some of the inserted members do not have any data. However, they remain in the report as long as you do not refresh the report. If you are using an input form (Use as Input Form option selected in the Options tab of the Report Editor), you can enter data in rows or columns that do not yet contain any data. Then, when you refresh the report, the columns or rows for the members 97 2013-09-04 Report Creation • that do not contain data are not displayed in the report. the inserted members are automatically removed. Related Topics • Member Entry Using the Member Selector 12. Restriction: You cannot use the Insert Members feature when an EPMDimensionOverride or EPMAxisOverride function is used in the current axis. For more information on empty columns and rows behavior. 2012. This behavior also applies to the expanded members (see Expand). Example: the Refresh only Expanded and Inserted Members option is selected. In a report. see No Data and Zero Values When modifying an axis or changing the context of an axis in which members have been inserted. select the user option Refresh only Expanded and Inserted Members. In Large Reports: Refreshing only Expanded or Inserted Members If you work with large reports and want to accelerate the refresh time. contains local members. The data are refreshed only for the members you have just inserted: 2011. the following members are displayed for the Time dimension: 2010. The following members are now displayed: 2010. Caution: Read the restrictions below before using the Refresh only Expanded and Inserted Members option: • • • Do not use this option if the axis on which the expansion/insertion is performed. The other rows or columns of data are not refreshed. This option can cause certain formatting settings to not be properly applied. see Dynamic Formatting Template Definition. To do so. Note: This option enhance performances. The member insertion action automatically does a refresh of the report.5 Report Creation using Copy/Paste You can copy and paste an existing report from and to: • a Microsoft Office Excel worksheet 98 2013-09-04 . You insert the 2011 member (right-click in a cell that belongs to the axis that contains the Time dimension and select EPM > Insert Members). contains EPMInsertCellsBeforeAfterBlock functions. 2012. For more information. you can specify that only the new inserted rows or columns are refreshed after a member insertion. 2011. but note that not all displayed data is refreshed in the report after a member insertion. Do not use this option if the axis on which the expansion/insertion is performed. Report Creation • a Microsoft Office Word document • a Microsoft Office PowerPoint presentation The connection is copied as well. select EPM > Report Actions > Copy Report > Paste Report. Note: You can view the report connection in the Layout tab of the Report Editor and above the dimension list in the EPM pane. To copy and paste a report. and the report is automatically connected. 99 2013-09-04 . Report Creation 100 2013-09-04 . Family dimension to the column axis. like this: Related Topics • Asymmetric Row Axis • Asymmetric Column Axis • Keep Member 101 2013-09-04 .Asymmetric Report Creation Asymmetric Report Creation To create asymmetric reports.Family dimension. Example: In the following example. This is a symmetric axis: You exclude Pretzels for Canada and Cookies for USA. For example. The excluded members are automatically stored in the report and appear in the Excluded Members tab of the Report Editor. Cookies and Pretzels) are selected members of the Product. Note: Deleting a row or column can break the excluded member selection. • Exclude members using the Excluded Members tab in the Report Editor. This is an asymmetric axis: Note that this efficient storage choice is also useful when you pivot. • Delete Microsoft Office Excel rows or columns. you can use several commands. the members are each displayed once. if you dragged the Product. • Enter members directly in the cells. • Use the Keep and Exclude commands from the EPM tab. all three product members (Chips. Asymmetric Report Creation • Exclude Member • Excluding Members 102 2013-09-04 . the entities are still displayed for February 2010. Note: The main entity to Group 1 is Entity 1 and the main entity to Group 2 is Entity 3. 103 2013-09-04 . where entities can be differently connected to or disconnected from groups according to Category and Time. For more information about excluding members. An ownership-based hierarchy combines Groups and Entity members. ACTUAL Jan 2010 Group 1 Entity 1 Entity 2 Group 2 Entity 3 Entity 4 Here is the group structure for the Actual category in February 2010. This behavior is standard with the Exclude Member feature. Ownership-based hierarchies are set up in the Consolidation Central view of Planning and Consolidation. which displays the dimensions Groups and Entity in the same axis.Ownership-based Hierarchies Ownership-based Hierarchies Applies to: Planning and Consolidation connections Ownership-based hierarchies support the legal structure of statutory consolidations. To do so. Note: • • Ownership-based hierarchies are only available in consolidation and ownership type models. The Exclude Member feature can be confusing when used in a report containing ownership-based hierarchies. Example: Entity difference between January and February Here is the group structure for the Actual category in January 2010. For each Groups member. create a report for the appropriate Category and Time. February 2010. its main entity is displayed in the cell before or after. whether it is the row or column axis. You can display in a report how the group structure has evolved over time. For example. see Exclude Member and Excluding Members. if you exclude the period member. ACTUAL Q1 2010 Group 1 Entity 1 Entity 2 Entity 5 Group 2 Entity 3 Entity 4 The quarter displays the union of the entities. Assuming that the group structure has not changed for the Actual category from February to March 2010. here is the group structure for the first Quarter of 2010. 104 2013-09-04 .Ownership-based Hierarchies ACTUAL Feb 2010 Group 1 Entity 1 Entity 2 Entity 5 Group 2 Entity 3 Entity 4 Entity 5 is new in Group 1. such as Sales by Region and Sales by Manager. You can choose a color or not to display the key date dropdown list in the EPM Context bar. then selecting Select Another Key Date and specifying the date in the dialog box that opens. version for SAP NetWeaver. • In the EPM Context bar. you specify that you want to use a time-dependent hierarchy. the Key Date dropdown list is available in the Layout tab. • In the Report Editor.Time-Dependent Hierarchies Time-Dependent Hierarchies Applies to: Planning and Consolidation. connections. The default date is the date specified in the context. You then specify the various versions of the hierarchy. All these settings are defined in the Options > Context Options. For a specific dimension. In order to use time-dependent hierarchies in the EPM add-in. Note: You can lock a key date. meaning that each version of the hierarchy has a different structure. then selecting Select Another Key Date and specifying the date in the dialog box that opens. You can select another key date by selecting the key date dropdown list. You can select another key date by selecting the key date dropdown list. 105 2013-09-04 . In the EPM add-in. they must have been previously set up in the Planning and Consolidation Administration view. you can select a key date for your report: the version of the hierarchy that is used is the one which contains the key date within the version. based on different periods of time. the current date is the default for the key date. Time-Dependent Hierarchies 106 2013-09-04 . 16. version for the Microsoft platform. Note: • • For descriptions of the options that are common to the sheet and the report. Display only Base Level Data.Actions and Options Specific to the Current Report Actions and Options Specific to the Current Report You can perform certain actions and specify certain options that are specific to the current report by using the Report Editor. this option can also be activated for any use of the EPM add-in in the User Options. Note: The option is always available for selection. connections. the options displayed are not always the same. Independently. • The following options are available for selection and are not necessarily related to the Sheet Options: • Freeze Data Refresh.1 Report Options You can modify the options that are specific to the current report in the Options tab of the Report Editor. Independently. These options only apply to Planning and Consolidation connections. this option can also be activated for any use of the EPM add-in in the User Options. To modify the options for the current report. leave the Inherit Sheet Options option selected as it is by default in the Options tab of the Report Editor. Depending on the cube or model to which the report is connected. All the options that are inherited from the sheet options are greyed out. Related Topics • Sheet Options • Freeze Data Refresh 107 2013-09-04 . deselect the Inherit Sheet Options option. By default. see Sheet Options. • • Do not Store Connection and Do not Store Environment in the Connection. All the options are made available for selection. This option only applies to Planning and Consolidation. the report options are the ones defined for the current worksheet in the Sheet Options. You can do the following: • To keep the options as they are defined in the Sheet Options. To do so. When you are finished navigating in the report. This way.Actions and Options Specific to the Current Report 16. If you only want to display the data that is not aggregated (meaning data on base level members). provided that the models have similar structures.3 Do not Store Connection and Do not Store Environment in the Connection Applies to: Planning and Consolidation connections.1. version for the Microsoft platform. Freezing the refresh of data enables you to navigate in a report however you wish. Tip: Select this option for reports that you want to use as templates.2 Display only Base Level Data Applies to: Planning and Consolidation. • You can save a report without storing the connection used to create the report. If you have selected Inherit Sheet Options in the Options tab of the Report Editor. you can re-activate the refresh and retrieve the latest data. The data calculations will not be performed and the data for base level members will be displayed more quickly. select the Do not Store Connection option. in the Options tab of the Report Editor. the Freeze Data Refresh option is selected or not. and the data is not loaded from the data source. you will then be able to use the report on other connections.1. 16. connections.1 Freeze Data Refresh You can deactivate the data refresh. meaning without storing the environment or the model of the connection. depending on whether or not you selected the option in eitherEPM > More or inEPM > User Options. Related Topics • Report Refresh 16. select the Display only Base Level Data option.1. 108 2013-09-04 . Note: You might sort by more than one column when you have data that you want to group by the same value in one column. if you have a Department and Employee column. For example. select the Do not Store Environment in the Connection option. 16. select the option in the message box and click OK (clicking Cancel will not take into account the option selection) or uncheck the Warn if Connection or Environment in the Connection is not Stored option in the User Options: these two options are synchronized. Since the connection or the environment is not stored: • dimensions are identified with their types (for example: E for Entity) and not with their names. based on: • Either a specified dimension member and for each dimension in the column axis. you can first sort by Department (to group all the 109 2013-09-04 . Note: If you have already selected the Do not Store Connection option. these members may not be recognized if you use the report later on with another connection. To do so. 16. You define the sorting. rank or filter the data of the current report. in the Options tab of the Report Editor. a message warns you that. and then sort another column within that group of equal values. provided that the model environments have similar structures. If you do not want to show the message again. You can sort the data in your report in ascending or descending order. you will then be able to use the report on other connections using other environments.2 Data Sorting.2. • dimension members are identified with their relationships (for example: context member + children) and not with their names. the Do not Store Environment in the Connection option is greyed out. as the report contains at least one member that is not a context member. Note: As soon as you select (or manually enter) a member that is not a context member.1 Data Sorting You can sort the data of the current report using the Report Editor. This way.Actions and Options Specific to the Current Report • You can also save a report without storing the environment of the connection used to create the report. Ranking and Filtering You can sort. ranking and filtering on data in three dedicated tabs of the Report Editor. click on the Clear Expression button. Click the ellipsis button. If you have selected First Column or Last Column. Select Member. while still preserving the hierarchy. By default. Select EPM > Edit Report. If you have selected Member: a. Data sorting is not supported on local members. Note: If the Sort Data Using the Following Criteria option is not selected. If you want to sort data based on a member that is not part of the column axis. you sort data based only on a member that is displayed in the column axis of the report. deselect the Show Only Members Displayed in the Report option. 5. e. If you want to sort data on another member.2. However. c. The Report Editor opens. if you have already entered settings. 2. The rest of the tab is activated. • Or the first or the last column. 110 2013-09-04 . 3. indicate whether data will be sorted in Ascending or Descending order by selecting one of the options. this tab is disabled. First Column or Last Column. Indicate whether data will be sorted in Ascending or Descending order by selecting one of the options. select the Sort Inside Level option. 4. To perform the sort in each level of the hierarchy. d. b. Select the Sorting tab. 16. Select the Sort Data Using the Following Criteria option. 8. 6. 7. they are not deleted.1. Note: If you have selected First Column or Last Column. The Sort Inside Level option enables you to sort parent members and their children in each level of the hierarchy. and then sort by name (to put the names in alphabetical order within each department). To delete the entire sorting query. you cannot add criteria for the sorting.Actions and Options Specific to the Current Report employees in the same department together). select the member on which the sort will be based and click on OK. In the Column Selector dialog box that opens.1 Sorting Data 1. Note: • • The sorting inside the levels is performed if the row axis contains only one dimension. click Add Criteria and repeat step 5. In the Filtering tab. only the data in rows or columns that meet the filtering criteria will be displayed in the report. • Retain Members and Keep Blocks options both selected: In the case where the row axis contains more than one dimension. you can also specify that not only the retained member be displayed in the report. • When you select the Filter on all Columns/Rows option and the OR option. Data filtering is not supported on local members. • • By default. Related Topics • Multidimensional or Nested Row Axis • Multidimensional or Nested Column Axis 16. a row or column is displayed if at least one data of the row or column meet the filtering criteria. • When you select the Filter on all Columns/Rows option and the AND option. the whole block to which it belongs is displayed.2.2. Select EPM > Edit Report. Note: • • For more information about blocks. The following options enable you to define specific actions on top of the filtering criteria: • Retain Members option: you can select one or more specific members that you want to display in the report.2.1 Filtering Data 1. whether or not they meet the filtering criteria. • Keep Blocks option: when a member is displayed in the report because it meets the filtering criteria. The system can also check if the criteria are met on each column or row in the report.2 Data Filtering You can filter the data of the current report using the Report Editor.Actions and Options Specific to the Current Report 16. see Multidimensional or Nested Row Axis and Multidimensional or Nested Column Axis . 111 2013-09-04 . You can specify one or more conditional dimension member value filters on the report. you can specify the individual criteria and you can combine all the criteria into an expression. a row or column is displayed if all the data of the row or column meet the filtering criteria. Note: The Keep Blocks option appears in the Filtering tab only if the row axis contains more than one dimension. but also the block to which the selected member belongs. To delete a criteria. select the Filter on all Columns/Rows option. So that none of the members are displayed in the report if at least one of the members does not meet the filtering criteria. Each expression will be entered on a new line in the Filter Expression area. select Retain Members. Therefore. the filtering takes precedence by default over the ranking. 3. the Keep Blocks option is available. To delete the entire expression from the Filter Expression area. Select the Filter Data Using the Following Criteria option. 10. If you want to filter data based on a member that is not part of the column or row axis. In the Filtering Criteria area. Select the Filtering tab. 8. 4. 6. To modify a criteria. 13. By default. Define the filter criteria using the three radio buttons and the corresponding dropdown lists. 9. The filter criteria defined are added to the Filter Expression area and the Filtering Criteria area is cleared. the Perform Filtering. 15. modify the criteria and click Modify Criteria. 7. The square brackets show the choices available in the drop-down menus: • [is | is not] NULL (Empty). Note: If there is more than one dimension in the column axis. select the criteria line in the Filter Expression area. deselect the Show Only Members Displayed in the Report option. i. use the Based on drop-down menu to select Row or Column. Note: To cancel the modification of the criteria. then Ranking option is 112 2013-09-04 . 12. If you want that specific members appear in the report. click Edit. Click the Add Criteria button. regardless the filtering criteria. 14. 11. If you want that not only members appear in the report but also the block they belong to.e. 2. Click on the ellipsis button at the end of the Based on field. The Column Selector dialog box opens. to avoid any conflict. click Cancel Edit. you filter data based only on a member that is displayed in the column or row axis of the report. select the criteria line in the Filter Expression area and click Delete. If you also define a ranking on data in the Ranking tab. click the Clear All Expressions button. select this option. The rest of the tab is activated. If you want to add more filter criteria select the AND or the OR operator and repeat steps 5 to 11. Select the member in row or column on which the filter will be based and click on OK. • [= | > | >= | < | <= | <>] a specified constant (must be numeric. you can select one member for each dimension on which to be filtered.Actions and Options Specific to the Current Report The Report Editor dialog box opens. 5. 16. Note: In case the row axis contains more than one dimension. real number). • [= | > | >= | < | <= | <>] another column specified using the Column Selector dialog box. Select the Ranking tab.1 Ranking Data 1. 16. they are not deleted.Actions and Options Specific to the Current Report selected by default. In the Column Selector dialog box that opens.3 Data Ranking You can rank the data of the current report using the Report Editor. Note: If there is more than one dimension in the column axis. Select how many items will be included in the ranking. 6. c. 7. Note: Data ranking is not supported on local members. If you want to rank data based on a member that is not part of the column axis. 113 2013-09-04 .2. 5. 16. Select Member. 4.2. if you have already entered settings. First Column or Last Column. 2. You can specify top or bottom 'N' ranking based on a specified dimension member and for each dimension in the column axis. 3. You can deselect it to change the precedence and the Perform Ranking.3. deselect the Show Only Members Displayed in the Report option. The Report Editor dialog box opens. you can select one member for each dimension to be ranked. b. The rest of the tab is activated. you rank data based only on a member that is displayed in the column axis of the report. If you have selected Member: a. Click the ellipsis button. Only the top or bottom “N” rows will be displayed in the report. Note: If the Filter Data Using the Following Criteria option is not checked. Select the Rank Data Using the Following Criteria option. However. then Filtering option in the Ranking tab is automatically checked. By default. for example. Indicate whether data will be ranked from the Top or the Bottom by selecting one of the options. this tab is disabled. Select EPM > Edit Report. select the member on which the ranking will be based and click OK. top 10 sales figures. The Edit Member Selection. 16. Note: • • 0 is not a valid value in this field.. this tab is disabled. If the Rank Data Using the Following Criteria option is not checked. You can select one or more members for one or more dimensions. the Perform Ranking. Therefore. if you have already entered settings. click the Clear Expression button. 9. Related Topics • Data Save 16. The Remove Members button enables you to remove all the members selected for the selected dimension. then click Select Members. For a specific input form. then Filtering option is not selected by default. However.4 Local Members 114 2013-09-04 . You can also specify ranges in read-only. If you also define a filtering on data in the Filtering tab.. select a dimension. button enables you to modify the member selection for the selected dimension and opens the Member Selector. and select the member(s) for which data will not be saved to the server.. You can select it to change the precedence and the Perform Filtering. Note: As data can be entered and saved only on base members. to avoid any conflict. you can choose not to save the data entered on: • Specific dimension members. So that only data at the intersection of the selected members is not saved. select the At Intersection Only option. selecting a node will have no consequence. they are not deleted. For more information.Actions and Options Specific to the Current Report 8.. To delete the entire ranking query. then Ranking option in the Filtering tab is automatically unchecked. see EPMReadOnlyData.3 Read-only Data Applies to: Planning and Consolidation connections. • The intersection of specific members. In the Read-only Data tab of the Report Editor. the filtering takes precedence by default over the ranking. whether the axis contains one or several dimensions. Note: • Local members are specific to the current report.Examples. • EPMDIM_CURRENT_MEMBER. The local member is displayed after the member to which it is attached. The local member is attached to a position in the report. to reference a row or column of the report. When the Local Member Recognition is activated. You can then view and modify the local member in the Local Members tab of the Report Editor. You can create custom members only when using a local or SAP BusinessObjects Enterprise connection. right-click on the local member in the report and select EPM > Convert to Custom Member. • EPMPOSITION(n). Note: You can also create a grouping local member in the Member Selector. The local member is displayed after the local member to which it is attached. • A position. you can convert the local member into a custom member. not to a specific member. • Row or column axis. These members are called "local members". not a member. and you have entered a formula that references two different members in the outer dimension. to attach the local member to the current axis. but they contain standard Microsoft Office Excel formula or EPM functions. Local members have the same behavior as any other member. A local member is attached to one of the following items: • Member combination. If you want to reuse a local member in other reports for the same sheet/connection couple. To convert a local member into a custom member. • • Keywords and Attachement A local member is identified by a formula using one of the keywords below: • EPMMEMBER. The axis to which the formula applies contains more than one dimension. • Another local member. Precedence rules: in case of conflicts between local members on row and column axis. • EPMSELECTEDMEMBERS. A formula that gives information about the members in the opposite axis. see Local Members . The axis in which the dimension is placed must contain only one dimension. • EPMTUPLE. 115 2013-09-04 . local members on the columns axis override the ones on the row axis by default. to perform a calculation (such as sum or average) on all the members displayed in a row or column axis. • EPMALLMEMBERS. • A member. all Microsoft Office Excel formulas are automatically converted into "local members". when grouping members by property. to attach the local member to a specific member. to perform a calculation (such as sum or average) on all the members displayed in the report for a specific dimension. You can change the precedence by selecting the Apply to rows as a priority in the Local Members tab of the Report Editor.Actions and Options Specific to the Current Report You can create members mainly for calculations on the current report. • Create a local member directly in the Local Members tab of the Report Editor. You can apply specific formatting to local members. For examples and explanations on how keywords and attachments are managed. There are two ways of creating local members: • Enter a Microsoft Office Excel formula. to attach the local member to a combination of members belonging to nested dimensions. RAND. For more information about blank members. provided that the Activate Local Member Recognition option is selected in the Sheet Options: • • the formula is automatically converted into a local member using a specific keyword. Note: • • • • • All Microsoft Office Excel formulas are converted into local members. a default name is generated. Related Topics • Dynamic Formatting Template Definition • Custom Members • Member Sorting and Grouping by Properties 16. If a member refered to in a local member is deleted. The local member position depends on the Totals Placement options selected in the Sheet Options. CELL (depending on its arguments). the local member is automatically attached to a specific item. For examples and explanations on how keywords and attachments are managed. INDIRECT. TODAY. the following Microsoft Excel functions are volatile: NOW. Restriction: References to more than 100 cells are ignored.Actions and Options Specific to the Current Report Use of Volatile Functions As mentioned in the Microsoft Excel documentation. INFO (depending on its arguments). enter text as the header of the row or column. When you enter in a report a Microsoft Office Excel formula.1 Local Member Automatically Detected You can insert a row or a column. As a reminder. If you do not enter a text to describe the local member. the use of too many volatile functions can lower the recalculation performances.Examples. Note: Once a formula has automatically been converted into a local member. you can edit the local member in the Local Members tab of the Report Editor: you can see for example the keyword used in its formula and the item to which the local member is attached. see Blank Member.4. then enter a formula. the local member becomes invalid. 116 2013-09-04 . OFFSET. see Local Members . A local member cannot be attached to a blank member. beginning with (fn). see Local Members . this does not apply to the EPMDIM_CURRENT_MEMBER type of local member.Examples. a combination of members. a prefix and also include the text of the outer member by selecting Outer Member in the dropdown list.Actions and Options Specific to the Current Report Local Member Attachment Any formula is converted into a local member and the local member is automatically attached to one of these items: a specific member. even though the Use Position in Axis option is not selected in the Sheet Options. For example: Sheet!C4. you must use appropriate keywords in the formula and you also need to attach the local member to the apropriate item. You can enter a suffix. meaning the local member is automatically detected as an EPMPOSITION type of local member. See detailed examples here Local Members . Caution: If you reference a sheet in the formula. You can perform the following actions in the Local Members tab: • • • Modify or select the item to which the formula is attached.2 Local Member Creation In the Local Members tab of the Report Editor. Note: However. the member is automatically detected as an EPMPOSITION type of local member. beginning with (fn). see Local Members . Enter a description. you can modify the automatically converted local member or you can create a new local member. 117 2013-09-04 . See detailed examples here Local Members . Note: When you have entered a formula in a cell and you have not entered a text to describe the local member. The name will appear in the list of local members on the left side. enter a formula using the appropriate keyword. Name the local member.Examples. The description appears in the report. Note: When a local member references the current report and another cell outside of the report. • In the Formula field. select the Use Position in Axis option in the Sheet Options. To see detailed examples of local members. Alternatively. To see an example of local members attached to a specific position in the row or column axis.Examples. 16. the column axis or a specific position in the report. the local member is not created. you can ask that any formula is converted into a local member that is attached to the row or column axis at a specific position. the row axis. a default name is generated. To do so.Examples.4. To create a local member that answers your analysis needs. When you have finished defining a local member. it will move along with the member. When you have modified an existing local member. For all the local members that have been created when the option was not selected. click Save to save your changes. when this option is selected. For more information. When a local member is enabled. To scan all the formulas. Caution: You can reference another worksheet in a local member formula. select the Use EPMMemberID in EPM formulas option in the User Options. you can specify that the "EPMMemberID" function be used automatically for members. For any cell reference containing members. Note: You can also create a local member that inserts a blank row or column to a specific member for example. you can scan all the formulas of the current worksheet. you can also specify a position using the Insert at Position dropdown list. For example. select the position where you want to insert the row or column and select the member to which you want to attach the blank row or column. Local Member Creation using Excel Cell References You can create local members whose formula use Microsoft Excel cell references and not EPM keywords (see above for keywords). when you reference a cell that contains a member placed in one of the three axes of the report (meaning a member identified by =EPMOlapMemberO). If the item to which the local member is attached is Dimension/Hierarchy (depending on the connection you use). However. Column Axis or Row Axis. provided that the name of the worksheet does not contain any numbers. A6 will be automatically replaced by EPMMemberID(A6) if A6 contains an EPMOlapMemberO function. Note that you can also insert a blank member that behaves like any other member and is not attached to a specific member. click Add. Note: • • The Use EPMMemberID in EPM formulas option and the Insert EPMMemberID in Formulas command apply to both EPM functions and local members. if you reference cell A6. simply enter a name for the local member. Select the Use Excel Cell References option in the Local Members tab of 118 2013-09-04 . Restriction: You cannot create a local member in a child report. select EPM > More > Insert EPMMemberID in Formulas. it is taken into account in the current report. To do so. Note: The rows and columns that are used as separation (shift) between the data grid and the row or column axis are ignored. the EPMMemberID function is added. In the Local Members tab. see Blank Member. • • • Enable or disable a local member by checking the Enable option. As this local member is attached to another member. using the ellipsis button. Referencing an EPMOlapMemberO In local member formulas. after or before the item to which the formula is attached. note that selecting this option may lower performances.Actions and Options Specific to the Current Report • Change the position of the local member. 3 Local Members . February and March.Example 1 You want to calculate the sum of the sales performed for any time period displayed in the report. you select 2012 for the Time dimension. Caution: The use of local members related to the context is recommended only with hierarchies whose parents have the same number of children. In the report below.4. 119 2013-09-04 . The Total local member sums all the time members currently displayed in the report. creating a local member related to the context on a hierarchy that can change (member added for example).Examples This section describes detailed examples of local members. 16. Local Member Attached to Another Local Member You can attach a local member to another local member. can lead to unintended calculations. In the context. To do so. The formulas of local members that are repeated will adjust and behave according to the Microsoft Excel relative references feature. the local member recalculates the sum for Q1 and Q4 2012. including how to use keywords in local member formulas and which item a local member can be attached to. Calculate the sum of the sales performed in various periods of 2010 . To do so. select the Related to Context option in the Local Members tab of the Report Editor. you have entered the following formula in cell E2: =SUM(B2:D2). 2011 is selected for the Time dimension. Q1 Sales 23152 Q4 24256 (Local member Q1+Q4) 47408 In the context. Since the local member follows the structure of the hierarchy.Actions and Options Specific to the Current Report the Report Editor. that is January. If the option is not selected. Example: In this report. such as time hierarchies (see example below). then select the Local Member option and select an existing local member in the Local Members list. you can specify that the local member be updated when a context member is changed. Local Members Related to Context Members For a local member that is attached to a member or a combination of members. Q1 and Q4 are context members. Provided that the Related to Context option is selected. create the local member. the local member is not displayed anymore in the report. you have entered the following formula in cell D3: =C3-B3.[]. the sum is updated accordingly. the sum would not be updated accordingly. if you add April. and provided that Actual is also displayed in the axis. the sum is updated accordingly.Example 2 Like in Example 1. A 1 3 Sales B Actual 32510 C Forecast 30450 D Difference 2060 When you click Edit Report and select the Local Members tab of the Report Editor. 120 2013-09-04 .[]. the local member will always appear after Forecast for each occurrence of Forecast in the report (in the case of nested dimensions for example).[FORECAST])-EPMMEMBER([CATEGORY]. you can see the following details on the local member: • the local member is attached to the last member in the report. if other dimensions are in the same axis as the Time dimension. 2010 2134 C Feb. If you had entered =B2+C2+D2. the selection is dynamic and if you remove February for example. When you click Edit Report and select the Local Members tab of the Report Editor. you need to use the keyword EPMALLMEMBERS in your local member formula: =SUM(EPMALLMEMBERS(TIME)) Calculate the difference between the forecast and the actual sales You want to calculate the difference between the forecast sales and the actual sales.[ACTUAL]) Note: Since the local member is attached to the Forecast member. Forecast (the Member option is selected). you can see the following details on the local member: • the local member is attached to the Period hierarchy (the Hierarchy option is selected). However. • the keyword EPMSELECTEDMEMBERS is used in the local member formula =SUM(EPMSELECTEDMEMBERS(TIME)) Calculate the sum of the sales performed in various periods of 2010 . Also. you want to calculate the sum of the sales performed for any time period displayed in the report. • the keyword EPMMEMBER is used in the local member formula =EPMMEMBER([CATEGORY]. In the report below.Actions and Options Specific to the Current Report A 1 2 Sales B Jan. 2010 2303 D March 2010 2405 E Total 6842 Note: As you have specified a member range by entering =SUM(B2:D2). you have entered the following EPM function in cell B2: =EPMMemberProperty("connection"."Account type"). A 1 2 3 B Total 2005 Bonus Expenses All Cost Cen. its type of account is displayed in a column. In the report below. For more information on the EPMMemberProperty function.Actions and Options Specific to the Current Report Calculate the percentage of changes in costs between 2005 and 2006 You want to calculate the percentage reflecting how personal costs have changed between 2005 and 2006.30000 ters C Total 2005 Personal Costs 25000 D Total 2006 Bonus Expenses 32000 E Total 2006 Personal Costs 28000 (fn) Personal Costs 12% F When you click Edit Report and select the Local Members tab of the Report Editor. [ P _ A C C T ] . The local member is displayed only if the members Total 2006 and Personal Costs are displayed in the same axis. [ P _ A C C T ] . you can see the following details on the local member: • the local member is attached to the column axis (the Column Axis option is selected): for each member in the row axis. [ 2 0 0 6 . [ P A R E N T H 1 ] . [ P A R E N T H 1 ] . ) / E P M T U P L E ( [ T I M E ] . • the keyword EPMTUPLE is used in the local member formula = E P M T U P L E ( [ T I M E ] . ) 1 Displaying the type of accounts of the members displayed in the row axis You want to display the type account for each member displayed in the row axis of the report. [ C E 0 0 0 4 0 0 0 ] . see EPMMemberProperty. "Account type") 121 2013-09-04 . • the keyword EPMDIM_CURRENT_MEMBER is used in the local member formula =EPMMemberProperty(. [ P A R E N T H 1 ] . T O T A L ] . the local member will also be displayed. In the report below. you have entered the following formula in cell F2: =E2/C2-1. A 1 2 3 4 5 Interest Income Tax Refund Personal Care Vacation B (fn) Account INC INC EXP EXP C 2010 40 239 12 202 When you click Edit Report and select the Local Members tab of the Report Editor. [ C E 0 0 0 4 0 0 0 ] . If you enter this combination of members somewhere else in the report.A2. [ 2 0 0 5 . you can see the following details on the local member: • the local member is attached to the following combination of members (the Member Combination option is selected): Total 2006 and Personal Costs. [ P A R E N T H 1 ] . EPMDIM_CURRENT_MEMBER(P_ACCT). T O T A L ] . Actions and Options Specific to the Current Report Calculating any members that are displayed in specific rows or columns You want to calculate the sum of the members that are displayed in the first and the second rows of the report. 2007 is selected. you can select any member of the dimension and the calculation will be performed. as explained in the first example. 2007 periods are displayed. you display members in the axis for any dimension and the calculation will be performed. As the row axis of the report below contains context members. To do so. The row axis displays context members. • 122 2013-09-04 . If you attach this local member to an axis. you have created a local member on the row axis by entering the following formula in the Local Members tab of the Report Editor: =EPMPOSITION(1)+EPMPOSITION(2) The local member calculates the sum of members that are on the first and the second rows of the report. In the report below. When you change the context. select the Use Position in Axis option in the Sheet Options. if this option is selected. A 1 2 3 4 2008 S1 2008 S1 (fn) total B C Personal Costs 2386 5231 7617 D Other Costs 256 632 888 Note: • If you attach this local member to a dimension/hierarchy. In the context. In our example. The report is updated accordingly and the local member continues to function. you can see the local member details in the Local Members tab: the local member is attached to the column axis and inserted at position 3. You can also attach a local member to the row or column axis at a specific position. A 1 2 3 4 2007 S1 2007 S1 (fn) total B C Personal Costs 2345 5657 7002 D Other Costs 345 596 941 You change the context and select 2008. the row axis will update accordingly and the local member will continue to function. The combination of members to exclude is added to the list on the right part of the tab. then delete the member row or column. the customized name will be displayed. you can choose not to display specific members. The name you choose for a member overrides all the other names of the member (such as caption or description) coming from the cube or model and available for selection in the Member Selector. and the member will appear again as soon as you perform a Refresh.. Note: In the Member Names tab. Therefore.. the name chosen in the Member Selector (such as caption or description) is displayed again. You can exclude a member or a combination of members using the Excluded Members tab of the Report Editor. click the arrow button. you can define the name you want for any member. and select the members in the Member Selector that opens. If you delete the customized name. In the Member Names tab of the Report Editor.Actions and Options Specific to the Current Report 16. Even though you do not use certain members. To delete the entered name. Select a dimension. • 123 2013-09-04 . then click Select Members. if you decide to display them later. select a dimension. button enables you to modify the member selection for the selected dimension and opens the Member Selector. The Remove Members button enables you to remove all the members selected for the selected dimension. When you have selected the members you want for the dimensions you want. 16. There are two ways of excluding members: • You can exclude a member from a report by clicking the Exclude button in the ribbon. Repeat this procedure for other dimensions. The Edit Member Selection.. The excluding member action is persistent and the excluded members automatically appear in the Excluded Members tab of the Report Editor. not only for members currently displayed in the report.6 Excluding Members For a specific report. then select the member for which you want to enter a name and click Override. If you want to exclude a member and do not want to save this action in the current report..5 Renaming Members For a specific report. the customized name is displayed in the report and in the Member Selector. select the checkbox corresponding to the name you want to delete and click Delete. you can enter a name for each member contained in the cube or model. Then. For more information about how to insert members. In your report. Note: • • The members of a combination are excluded in the report if they belong to the same axis. see Member Entry Using the Insert Members Dialog Box. then click Select Members. Once you have created a filter on a specific dimension. or you can delete it by clicking Remove Members. you will be able to insert in the report. In the Member Selector that opens. you will be able to insert different entities.7 Member Insertion Filtering For a specific report.. A combination of members must include members that do not belong to the same dimension/hierarchy. Select a dimension. click the filter icon. Related Topics • Member Entry Using the Member Selector 124 2013-09-04 . The plus-icon button enables you to add a member selection to the combination of members to exclude.. Example: Filtering Entities by Currency Context Member You want to be able to insert the entities for which the currency is the context member of the Currency dimension. you can create filters in order to restrict the member selection list when using the Insert Members functionality. Related Topics • Exclude Member 16. You can modify the member selection by clicking Edit Member Selection. the members specified in the filter. To do so. depending on the currency you select in the context bar. in the Member Selector for the dimension Entity. select the members that will be possible to insert in the current report.Actions and Options Specific to the Current Report The cross-icon button enables you to remove the combination of members to exclude. click Add Dynamic Filter. You create the filters in the Member Insertion Filtering tab of the Report Editor. Note: Even if the worksheet or workbook is protected. then select the following information: Currency = <CONTEXT> Currency. see Worksheet Protection. For more information about protection. you will be able to insert in the report the members specified in the filter. as if you had not perform a sorting. then select EPM > Sort Ascending or EPM > Sort Descending. the report is reset to its previous state. The sorting is temporary. as soon as you perform a refresh.8 Microsoft Excel Features for Report Layout If you use the following standard Microsoft Excel features to modify the layout of a report. the members are sorted. The sorting is performed quickly because no refresh action is performed on the report. To perform a sorting. right-click on a cell.9 Ad-hoc Data or Member Sorting You can sort the data or the members of the column axis of a report. • If the selected cell belongs to the data area. • If the selected cell belongs to the row axis. As soon as you perform a refresh. the actions performed are not kept.Actions and Options Specific to the Current Report 16. • Sorting data • Filtering data 16. 125 2013-09-04 . the data is sorted. Actions and Options Specific to the Current Report 126 2013-09-04 . 127 2013-09-04 . In this case. • By default. Before defining the content of the report. the report is created on the active connection. The names of the report will appear in the dialog box where you can delete the reports. The first report created in a sheet is named Default Report. select Select Another Connection from the Active Connection dropdown list. • If you want to create the new report on a connection that has not yet been connected. Note: For optimal use of the EPM add-in. Once the first report has been added to a sheet. Note: The three axes can be shared from three different reports as long as the page axis remains above the two other axes. the New Report button is enabled. using the [. you need to connect the report.. restrictions exist when sharing an axis. However. You can modify the names of each report in the Name area of the Layout tab of the Report Editor. The Connection Manager opens. The name of the connection the report is using is displayed in the Layout tab of the Report Editor and in the Current Report area of the EPM pane. Each report has a name. the column axis or the page axis of another report. whether the reports are connected to the same cube/model or not. the Report Editor appears.. You can define a shift between the data grid and the row and column axis using the Shift areas. A default name is given to each new report. • If you want to create the new report on a connection other than the current one. the row axis will be positioned on the right side of the data grid. The active connection is the one selected in the Active Connection dropdown list. the connections that are available are the connections that you have connected since you opened the current Microsoft Excel instance. all the reports must be connected. whether the reports use the same connection or different connections. select it from the Active Connection dropdown list. You can share the row axis.] Axis Shared With dropdown lists. when using several reports in a worksheet. Sharing Axes You can share axes between several reports that belong to the same sheet. You can enter negative numbers for the row axis only. When selecting it. In this list.Several Reports in a Sheet Several Reports in a Sheet You can define several reports in the same sheet. R2 is the child report. the reports are aligned on the sheet for readability. Any action performed on shared axes (such as expand or collapse) applies to all the reports using the shared axes. However. the system looks for and re-organizes the members that have the same captions. If the system does not find a member. R1 is the master report. see No Data and Zero Values.1 Restrictions with Several Reports in a Sheet When a sheet contains several reports. Example: • • • • You have created report "R1". On the same sheet. the Rows or Columns area is not displayed in the Options tab of the Report Editor). you cannot use the hide empty rows or columns. For more information. a tooltip indicates that clicking the icon highlights the current report. In the Layout tab of the Member Selector. Note: When you share an axis that contains a hierarchy or dimension that exists in the other report. you place dimensions in the row axis and you select "R1" in the Row Axis Shared with dropdown list. You can change it by using the option Set Default Value when Member not Found in Shared Axis in the Sheet Options and also in the Options tab of the Report Editor. The Current Report dropdown list in the EPM pane enables you to determine to which report the selected cell belongs. which are called "child reports". it may not be easy to distinguish the different reports from one another. Child reports inherit the No Data and Zero Values option that is selected for the master report. You are therefore ensured of performing an action in the correct report. The text by default is #NOMEMBERFOUND. a text is displayed in the cell of the report instead of the data of the member.Several Reports in a Sheet When sharing axes. Use the icon under Current Report in the EPM pane to distinguish them at a glance. Related Topics • Report Editor's Layout Tab Presentation • Delete Reports • Report Highlight • Connection Management • Active Connection for the Current Sheet 17. 128 2013-09-04 . You cannot change the No Data and Zero Values option for each shared axis of child reports (depending on the axis that is shared. When mousing over the icon. Restriction: on the No Data and Zero Value feature. Sharing Axis: " master report " and " child report " The "master report" is the report whose axes are shared with other reports. you create report "R2" by clicking New Report from the EPM tab of the Ribbon. To delete reports. select a cell belonging to the report you want to highlight and click the icon in the EPM pane. You cannot modify this. The Delete Reports dialog box is composed as follows: • In the Default Report column. The other reports that are based on the master report axes are moved along with the master report. Note: Deleting rows or columns using standard Microsoft Excel commands does not delete a report from the worksheet. If the report uses the row axis of another report. Report 2 inherits the shift. column axis and data grid. • Only the report (master report) on which the axes are shared can be moved in the sheet. the Shift feature is not applied. Solution: add a shift of 1 in the column axis of the report 1. Report 2 shares the row axis of report 1 (master report). When adding a dimension in the column axis of report 2.Several Reports in a Sheet Restrictions exist when sharing axes between several reports: • Shift feature: you can enter a negative number for the row axis only in the report that is the owner of its row axis.3 Delete Reports You can delete one or more reports from a sheet. check the boxes corresponding to the reports you want to delete. To highlight a report. the default report is checked. When mousing over the icon. Note: The first report created in the sheet is considered as the default report and it cannot be deleted. The different areas of the report are highlighted using colors: page axis.2 Report Highlight When a sheet contains several reports. This feature enables you to differentiate reports from one another. • Adding a dimension on a shared axis. 129 2013-09-04 . you can use the highlight icon below Current Report in the pane. a tooltip indicates that clicking the icon highlight the current report. row axis. In the Delete column. The Delete Reports dialog box opens. report 1 is not moved along. A blank row is displayed in report 2 and you can add a dimension on this row. 17. select Report Actions > Delete Reports. Related Topics • No Data and Zero Values 17. If you uncheck this option. the reports will still appear but they will be disconnected. unchecking this option can be useful if you do not need to navigate in a report or refresh the data. This option enables you to keep the report as a simple copy in the sheet.Several Reports in a Sheet • • The Axis Shared By Reports column displays information when several reports share the same header in the sheet. For example. but you still want to keep the data. The Clear Report Cells option is selected by default. 130 2013-09-04 . the data of the EPM functions. Everything that is in the selected worksheets is refreshed: the data of the reports. You can refresh: • Using the Refresh Report Data only command: Only the data for all the reports in the worksheet. is indicated in each EPM function section of this documentation). formulate and execute the query and then retrieve the data into the corresponding data grid. the connection dialog box automatically opens. This means you are in full control of when the data is updated and you can ensure that the data has not changed since you last saved the workbook. the report itself (including local member data and formatting) and certain EPM functions contained in local members (whether an EPM function is refreshed or not with the Refresh Selected Report action. You can also refresh the EPM functions selected. you can refresh one cell range at a time and all the cells of the range must belong to the same report. all the reports (including local member data and formatting) and all EPM functions. • Selecting several worksheets and clicking the Refresh button: select the worksheets you want to refresh by selecting their tabs and click Refresh. When you perform a Refresh. you can specify if you want a warning message to be displayed when the current report contains more cells than the authorized number you have specified. Note: In the Report Refresh area of the User Options. The application refreshes hidden rows and columns for valid members that may affect the layout. the data of the EPM functions. A refresh of the selected report is automatically performed after navigational and layout operations that apply to valid reports: 131 2013-09-04 .Report Refresh Report Refresh To populate or refresh your report with the currently connected data source. The Refresh command causes the application to scan the selected report or all the reports for valid reports. all the reports (including local member data and formatting) and all EPM functions. Note: A report is not refreshed with data unless you connect it and perform a Refresh. • Using the Refresh Workbook command: Everything that is in the current workbook: the data of the reports. • Using the Refresh Selected Report command: The data of the selected report. all the reports (including local member data and formatting) and all EPM functions. • Using the Refresh Worksheet command: Everything that is in the current worksheet: the data of the reports. This is the default action when clicking the Refresh button directly. except the data for local members. • Using the Refresh Selected Data command: The selected data. use the Refresh command. and a report is not connected. the data of the EPM functions. For a report. When you have a very large asymmetric axis and an out-of-memory message appears when you refresh the report. the formula will not work. it is automatically selected in the User Options. Merged Cell Behavior after a Refresh • Only the row axis. Any other merged cells are left merged. Note: When you select Freeze Data Refresh from the More menu. 132 2013-09-04 . and vice versa. provided that the option Apply only Report Editor Definition for Faster Refresh is not selected. Note: You can also freeze the data refresh for a specific report in the Options tab of the Report Editor. Freezing the refresh of data enables you to navigate in a report as you wish and the data is not loaded from the data source. Both are synchronized. select a cell belonging to the report you want to refresh. • Caution: If you merge cells that are used by a local member formula. select the Force Symmetric Refresh for Large Asymmetric Axis option in the User Options dialog box.1 Refreshing Reports 1. If you want to refresh specific data cells. and only if the report is not modified and not moved in the worksheet.Report Refresh • • • • • • Expand Collapse Keep member Exclude member Changes in the Report Editor Selection changes in the page axis You can deactivate and reactivate the data refresh feature by selecting EPM > More > Freeze Data Refresh or by selecting the Freeze Data Refresh option in the EPM > User Options. Related Topics • Freeze Data Refresh • Apply only Report Editor Definition for Faster Refresh 18. select them. column axis and data grid cells are unmerged after a refresh. if the option Apply only Report Editor Definition for Faster Refresh is selected. When you are finished navigating in the report. If you want to refresh the current report and if the current sheet contains several reports. This is a Microsoft Excel limitation. you can activate the refresh again and retrieve the latest data. All merged cells are left merged after a refresh. the default report will be refreshed. • EPM > Refresh > Refresh Worksheet. • EPM > Refresh > Refresh Selected Data. meaning the reports and the EPM functions. you do not need to select a cell. When you click the Refresh button (without selecting an option in the dropdown list). select: • EPM > Refresh > Refresh Report Data only • EPM > Refresh > Refresh Selected Report.Report Refresh Note: If the current sheet contains only one report. • EPM > Refresh > Refresh Workbook. Depending on what you want to refresh. the worksheet is refreshed. Related Topics • EPM Functions 133 2013-09-04 . and if you select a cell that does not belong to any report. 2. If the current sheet contains several reports. Report Refresh 134 2013-09-04 . Members Displayed on Node Expansion in Member Selector. See Open a Report when Dimensions or Members have Changed. See Report Navigation. Expand/Collapse on Single Member. See Metadata Cache. follow the associated links. You can change the default values of any option directly in the file. it is automatically selected in the User Options. See Freeze Data Refresh. Keep/Exclude on Single Member. See Expand on Nested Axis and Collapse on Nested Axis. See Keep Member. The options are organized into three tabs: • Navigation tab: • • • • • • Enable Double-Click. Refresh Charts Automatically. See Dynamic Charts . See Open a Report when Dimensions or Members have Changed. The following options are described in other sections of the help documentation. Note: When you select Freeze Data Refresh from the More menu. See Expand and Member Entry Using the Insert Members Dialog Box. • • • • • • • Activate Metadata Cache and Clear Metadata Cache Frequency. Automatic Refresh on Context Changes. Word or PowerPoint is closed and reopened.User Options User Options You can define options that will apply to any use of the EPM add-in. Both are synchronized. Freeze Data Refresh. See Member Entry Using the Member Selector (on Large Volume Data Sources). Refresh only Expanded and Inserted Members. Note: • • Some options are only related fo features available in Microsoft Office Excel and therefore have no impact when using Microsoft Office Word or PowerPoint. Exclude Member and Asymmetric Report Creation. For more information about these options.xml file located in \Users\[ID]\AppData\Local\EPMOfficeClient. See Double-Click Actions. Keep Rows and Columns of Unrecognized Members. Changes to this option will persist when Microsoft Office Excel. See Context. Warn if Rows and Columns of Unrecognized Members Will be Kept. All the user options are stored in the EPMClientPreference. and vice versa. Warn if Navigation will Break Dynamic Selection. Server Configuration tab: 135 2013-09-04 . Display Warning when Process Takes Time. For more information about No Data and Zero Values options. SMTP Server Configuration options. As the Keep all feature is selected for an axis of the report. drag and drop of a dimension in an axis area in the EPM pane. When connected to an SAP BusinessObjects Planning and Consolidation. Apply Specific Formatting to Large Key Figure. Fewer rows or columns may be displayed and the process will be faster. model. • A large number of rows/columns (more than 5 000) are about to be displayed in the report. Explained in the SAP BusinessObjects EPM Solutions. Display Context inside EPM Pane. The warning message indicates that a large number of rows or columns are about to be displayed in the report and that therefore. See Connection Management. Display Local Connections. click OK in the Report Editor. Explained in the SAP BusinessObjects EPM Solutions. See Languages. member expansion (using the double-click on a member or the Expand button from the EPM tab). This warning is displayed after the following actions: any refresh action. You can modify the settings of the style by clicking the Edit button next to the option: the Microsoft Excel standard Style dialog box opens. add-in for Microsoft Office Installation Guide. Context Bar and Pane options. click Cancel and select an option different than Keep all in the No Data and Zero Values area in the General tab of the Sheet Options or in the Options tab of the Report Editor. SAP Portal. See Quick Links. If not. See Data Disaggregation . See Workbook Distribution. the cells containing rounded data are applied a specific formatting. If you select the user option Apply Specific Formatting to Large Key Figure . Display tab: • • • Display Disaggregation Warning. See Main Interface Areas. EPMLink and EPM PathLink. If you still want to display all the rows or columns. See Context and Main Interface Areas. See Data Save and Comment Creation and Modification. The formatting is a standard Microsoft Excel style called EPMLargeKey Figure. See Open and Save Dialog Box Description and Actions . see No Data and Zero Values.User Options • • • • • • • • • • • • SAP BusinessObjects Enterprise Server. Display Warning when Saving Data or Comment. the data that exceeds the Microsoft Excel limit of 15 significant digits are rounded.and provided that the Enable Large Key Figure option is selected on the administration client side -. Open/Save Root Folder area. See Member Entry Directly in a Sheet. version for SAP NetWeaver. you can click OK. Quick Links and Link-Related EPM Functions options. 136 2013-09-04 . the process will take some time. You can select Remove Empty or Remove Empty and Zero Values. A warning message appears when the following criteria are met: • The Display Warning when Process Takes Time option is selected (the option is selected by default). Apply Specific Formatting to Unrecognized Members. all rows or columns will be displayed even if they are empty or contain zero values. add-in for Microsoft Office Installation Guide. Languages option. Refresh only Data on "Save & Refresh Data" option. See Report Refresh . Do not Protect Workbook option.User Options Note: When saving data to the server. Load EV Functions. they are detected to be the same data and are not saved back to the server. the rounded data (that have not been modified) are different form the data on the server because they have been rounded. Enable Manual Entry of Members option. See Report Refresh . See Workbook Sheet Automatic Generation. • • Collapse Dimension Tree View. See Report Creation using the EPM Pane and Report Editor's Layout Tab Presentation. Send Parent Data to the Server on "Save Data" option. See EPM Functions. See EPM Functions and Local Member Creation. However. Others tab: • • • • • • • • • • Warn if Report Exceeds option. See Offline Mode. See Data Save. Empty Comment option. Use EPMMemberID in EPM formulas. See Update. See Data Save. Force Symmetric Refresh for Large Asymmetric Axis option. Notify me when updates are available option. 137 2013-09-04 . See EPMSaveComment. Remove EPM Worksheets Before Generation option. See Context . User Options 138 2013-09-04 . The options are as follows: • • Member and Children.Sheet Options Sheet Options The sheet options apply to the current worksheet. The sheet options apply by default to any report on the sheet.1 General Sheet Options 20.xml file located in \Users\[ID]\AppData\Local\EPMOfficeClient. Children 139 2013-09-04 . then the sheet options will also be copied to the new sheet. If you copy a worksheet. select EPM > Options > Sheet Options.1. click the Save as Default button. Note: All the sheet options are stored in the <DefaultSheetOptions> section of the EPMClientPreference. 20. To access the Sheet Options dialog box. Note: The report options are accessible in the Options tab of the Report Editor. To apply all the options to any new sheet added to the workbook.1 Expand Options This option controls what scope of member expansion occurs when you perform an expand on a member. This is the default option. Note: The two following options apply to all the worksheets in the workbook: Refresh the Whole File when Opening it and Clear Data on the Whole File when Saving it. The sheet options persist for the sheet when the workbook is saved. You can change the default values of any option directly in the file. etc. Related Topics • Data Save 20. then perform a refresh on the sheet. you can deselect the Use as Input Form option.Sheet Options • • • Member and Descendants Descendants Custom Expand. For example: only level 4.2 Use as Input Form Applies to: Planning and Consolidation connections. If you want to enter and save data. When you select Custom Expand. using the Expand list in the EPM tab of the ribbon. select the option.1. Related Topics • Activating or Deactivating the Member Recognition Options • Local Member Automatically Detected 140 2013-09-04 . the selected member and down to level 3. If you encounter long loading time when opening reports and if you do not want to use the reports as input forms (to input and save data to the server).1. The option you select for the sheet applies by default when you perform an expand on a member in a report. Related Topics • Expand • Collapse 20. you can apply another option. You can then enter data and save it to the server. However. a dialog box opens and you can define the levels you want to display and if you want to include the selected member or not.3 Member Recognition Activation The Member Recognition and the Local Member Recognition can independantly be activated or deactivated. Example: If the Top and the Left options are selected. the checkbox corresponding to the current sheet is unchecked in the Report Connections dialog box. the worksheet from which you perform a log on is always considered as an EPM worksheet and the sheet option EPM Worksheet is automatically selected.dll. • On the right side on the column axis. You can change the totals placement for the current sheet in the General tab of the Sheet Options by using the Totals Placement options. You can disconnect a worksheet by deselecting the EPM Worksheet option in the Sheet Options.config file. You can reconnect a worksheet at any time by selecting the EPM Worksheet option.4 EPM Worksheet By default. Related Topics • Selectively connecting or disconnecting sheet/connection pairs 20. or by using the Report Connections dialog box. you can connect or disconnect several sheets at the same time. the data is displayed as shown below. You can then modify the totals placement for a specific report in the Options tab of the Report Editor.5 Totals Placement By default. meaning a worksheet that uses one or more connections and on which you can use the EPM add-in features. 141 2013-09-04 . if the AutoActiveEPMSheet parameter is set to TRUE in the FPMXLClient.Sheet Options 20. totals are displayed: • At the bottom on the row axis. The changes will be taken into account by default for any report in the sheet. Note: However.1. Tip: Using the Report Connections dialog box.1. Consequently. any worksheet is considered as an EPM worksheet. 142 2013-09-04 .Sheet Options If the Bottom and the Right options are selected. the data is displayed as shown below. see Member Entry Using the Insert Members Dialog Box. you can therefore enter data in rows or columns that do not yet contain any data. Note: • • • • • In a nested axis. Only the Keep all and Remove Empty options are available. child reports inherit the No Data and Zero Values option that is selected for the master report. Then. automatically removes any row or column in the report that has no data or that contains zero values after every operation that refreshes the cube or model. Note that you cannot hide the empty columns and the empty rows for a report. You cannot change the No Data and Zero Values option for each shared axis of child reports (depending on the axis that is shared. Note: • • By default. empty rows and empty columns are kept in the report. the Remove Empty option cannot be turned on for empty columns at the same time as the Hide Empty option for empty columns. you insert members using the Insert Members dialog box. However. • • • The Remove Empty and Zero Values option applied to rows or columns.6 No Data and Zero Values You can select options that deal with rows or columns that contain no data or zero values in the reports. they remain in the report as long as you do not refresh the report. If you are using an input form (Use as Input Form option selected in the Options tab of the Report Editor). The Remove Empty option applied to rows or columns. automatically removes any row or column in the report that has no data after every operation that refreshes the cube or model. For more information. for example the next month. It can be very useful when you expand to lower levels in a sparse portion of the cube or model that has a lot of empty rows or columns. It can be very useful when you expand to lower levels in a sparse portion of the cube or model that has a lot of empty rows or columns. see Several Reports in a Sheet . In the case where several reports share an axis. Some of the inserted members do not have any data. Then. the Remove Empty option cannot be turned on for empty rows at the same time as the Hide Empty option for empty rows. when you refresh the report. the Rows or Columns area is not displayed in the Options tab of the Report Editor). this may result in an asymmetric report. you can modify the settings for a specific report in the Options tab of the Report Editor. 143 2013-09-04 .1.Sheet Options 20. The settings you define for the sheet apply to all the reports of the sheet. To avoid confusion. the columns or rows for the members that do not contain data are not displayed in the report. The removed rows or columns will not come back even if the missing rows or columns subsequently contain data in the cube or model. You have selected the Remove Empty option for rows or columns in the Sheet Options. For more information on the Insert Members feature. Empty rows and columns behavior for inserted members. To avoid confusion. However. Since the rows or columns are just hidden and therefore still read by the add-in. they will be automatically unhidden if a subsequent Refresh is performed and they now contain data. you must explicitly unhide them yourself if you want to redisplay all rows. Since the rows or columns are just hidden and therefore still read by the add-in. Therefore. The rows or columns can be manually unhidden using the regular Microsoft Office Excel commands. This is useful to create more concise and printable reports that have a large percentage of rows or columns that are empty but may vary based on the page axis member selections. automatically hides any row or column in the report that has no data or that contains zero values and unhides any row or column that does have data. For example. For example. To avoid confusion. It can be very useful when you expand to lower levels in a sparse portion of the cube or model that has a lot of empty rows or columns. The rows or columns can be manually unhidden using the regular Microsoft Office Excel commands. When a sheet contains more than one report. Note: • When the Hide Empty option is turned off for rows or columns. when you change a page axis member to a different product.7 Show as Microsoft Excel Comments Applies to: Planning and Consolidation connections. but may vary based on the page axis member selections. • • • The Hide Empty and Zero Values option applied to rows or columns.1. Related Topics • Asymmetric Report Creation 20.Sheet Options • The Hide Empty option applied to rows or columns. region or time period. This is useful to create more concise and printable reports that have a large percentage of rows or columns that are empty or contain zero values. region or time period. the Hide Empty option is not available. 144 2013-09-04 . automatically hides any row or column in the report that has no data and unhides any row or column that does have data. This is a standard Microsoft Office Excel hide (right-click on a Microsoft Office Excel row or column header and then choose the context command Hide Empty). the Hide Empty option cannot be turned on for rows or columns at the same time as the Remove Empty option for rows or columns. the add-in will not automatically unhide every row or column since you may have some rows or columns hidden for other reasons. This is a standard Microsoft Office Excel hide (right-click on a Microsoft Office Excel row or column header and then choose the context command Hide Empty). they will automatically be unhidden if a subsequent Refresh is performed and they now contain data other than zero. when you change a page axis member to a different product. the comment is displayed by default in the cell in which you have entered the fonction. Note: Even if the worksheet is protected. The indentation is often kept in final reports as well. It can also be modified using the Microsoft Office Excel increase and decrease indent buttons. you can still modify the comments directly in the tooltips. When you rest the pointer over the red triangle. when you use an EPM function that retrieves a comment.2. Related Topics • Comment Display in a Cell • EPMCommentFullContext • EPMCommentPartialContext • Worksheet Protection 20. • In a report. if you select Edit Objects in the Protection tab of the Sheet Options.2 Formatting Sheet Options 20. When selected. You can modify the comments directly in the tooltips. • Indent Parents Indentation is very useful during ad-hoc navigation as a visual clue to the relationship of members.Sheet Options The Show as Microsoft Excel Comments option enables you to display comments as standard Microsoft Office Excel comments: a small red triangle in the corner of a cell indicates that the cell has a comment attached to it. The options are as follows: • No Indentation • Indent Children. this option displays the following Planning and Consolidation comments: • Outside of a report. any comment at the intersection of members is displayed. This is the default option.1 Row Header Indentation The Row Header Indentation options control the indention of child members relative to their parents in the row axis of all the reports of the current sheet. the comment is displayed in a tooltip. 145 2013-09-04 . The indentation is achieved by modifying the indent setting that can be seen in the Microsoft Office Excel menu Alignment tab of the Format Cells dialog box. 3 Auto Fit Column Width When the Auto Fit Column Width option is selected.All Customers. you can then choose other member names to display as alternatives to the captions. including the dimension and the hierarchy.2.CA.All Stores. For more information.CA. 20.All Gender. This feature can be beneficial when you are doing ad-hoc analysis. This is equivalent to selecting all the columns containing the report and double-clicking on the right boundary of the Microsoft Office Excel column header after each EPM add-in operation. see Member Name to Display. Note: In a report. This name is the one that has been defined in the cube or model as the default name. Following are some examples from the "FoodMart 2000 Sales cube": Caption M San Diego Full Unique Name Gender.USA. • Full Unique Name.Alice Cantrell Alice Cantrell 20. 146 2013-09-04 .2. the application automatically changes the width of all columns of the report so that they fit the contents after any refresh operation.San Diego Customers.Altadena. This name is the fully qualified member name.USA.Sheet Options Note: You can specify a different row header indentation for a specific report in the Options tab of the Report Editor.M Store.2 Display Name You can choose the type of member name you want to use in the reports as follows: • Caption. you can select the sub-option Use Excel Cell References below the Repeat Row Headers option. the other occurrences of the header use Microsoft Excel cell references and references the cell that contains the first occurrence of the header. For the following report.4 Repeat Row Headers and Repeat Column Headers In a nested axis. the Repeat Row Headers is not selected: For the same report. When selecting this option.2.Sheet Options 20. You must perform the navigation actions on the first occurrence of the header. These two options are not selected by default since reports are more readable without the row headers repeated. select the Repeat Row Headers or Repeat Column Headers. This feature can be beneficial if you subsequently apply Microsoft Office Excel filtering or export the report sheet to a tab or comma delimited file. the first occurrence of a header is identified as an EPMOlapMember. To do so. you can repeat all the outer dimension row or column headers so that there are no blank cells in the nested row axis. the Repeat Row Headers option is selected: Improving Refresh Performances If you need to improve refresh perfomances. the navigation actions are consequently deactivated on the headers that use Excel cell references. 147 2013-09-04 . Restriction: when this option is selected. inside a block. • #Missing Note: • • Empty cells (no data) are not the same as cells with zero in them. By default. 148 2013-09-04 . 20. 20. The cell is left blank. a text is displayed in the cell of the report instead of the data of the member.2. You can change this text.5 Display Dimension Names You can choose to display the names of the dimensions used in the row and column axis of all the reports of the current worksheet. select the Display Dimension Names option.6 Empty Cell Default Value The Empty Cell Default Value is the label that can be displayed in any report cell of the current sheet that has no data. "N/A" appears in the cell. To do so.2. The text by default is #NOMEMBERFOUND. You can specify a different empty cell value for a specific report in the Options tab of the Report Editor. If the system does not find a member. although it is recommended they be treated as zero in calculations.7 Member not Found Default Value The Member not Found Default Value is the label that can be displayed in any report cell of the current sheet when a member is not found for the following reason: you share an axis that contains a hierarchy or dimension that exists in the other report. • N/A. the system looks for and reorganizes the members that have the same captions.Sheet Options 20. You can enter a value of your choosing. such as: • Blank. the number 0 will appear in the cells.2. Note: You can specify a different value for a specific report in the Options tab of the Report Editor. To do so. Note: The formulas are not kept in the following situations: 149 2013-09-04 .8 Apply Dynamic Formatting You can apply a specific dynamic formatting to the current sheet. If the reports to which you want to apply dynamic formatting. • Clear the existing format so that only the EPM dynamic formatting is applied. it means that you must first display at least the default formatting sheet by clicking View Formats in the EPM tab of the ribbon.2. You can specify a different dynamic formatting for a specific report in the Options tab of the Report Editor.1 Keep Formula on Data and Show Source Data in Comments You can enter a formula in a cell that already contains data.3 Refresh Sheet Options 20. the formula is removed. The Default Formatting Sheet dropdown list is made available. Note: • • If the Apply Dynamic Formatting option is not available for selection. select the Keep Formula on Data option.3. When you perform a refresh.Sheet Options 20. deselect the Clear Report Format before Applying Dynamic Formatting option. Related Topics • Dynamic Formatting 20. Select one of the dynamic formatting sheets you have defined. If you want the formulas entered on data to remain after a refresh. including the standard Microsoft Excel styles dedicated to the EPM add-in (called EPMUnrecognizedMember and EPMLargeKeyFigure). select the Apply Dynamic Formatting option. in order to apply it to the reports of the current sheet. you can do as follows: • Keep the existing formatting and override it with the dynamic formatting. select the Clear Report Format before Applying Dynamic Formatting option. To do so. already contain formatting (for example formatting applied by an add-in other than the EPM add-in). To do so. select the Show Source Data in Comments option and perform a refresh. Example: Example with several dimensions in an axis Financial Accounts EUR . When you change or add dimensions in the different axes. the comments will still remain in the report. it is no longer the source data from the cube or model.3. To keep formulas in such a case. After a refresh.Net Equity 30 10 20 150 2013-09-04 . You must delete them manually. When you have chosen a context member selection for a dimension in your report and you change the context member using the EPM Context bar. select the Calculate Parents in Hierarchies and perform a refresh. you can perform a sum on each parent in the hierarchies included in a report. Note: • • A sum is performed on a parent only if all the children of a parent are displayed in the report. Note: • • Once you have displayed the source data in comments. then perform a refresh. if you uncheck the Show Source Data in Comments option. Note: You can modify these options for a specific report in the Options tab of the Report Editor.Sheet Options • • • • • When you share an axis with another report. The data on each parent is replaced by a sum formula. you can use the Keep Formulas Static that Reference Report Cells option.Euro All FC00-Opening FC01 . Comments displaying source data take precedence over all other comments in the report.2 Calculate Parents in Hierarchies For simulation purposes. See Keep Formulas Static that Reference Report Cells . the data displayed is the result of the formula. 20. You can still display the source data as a Microsoft Office Excel comment (which you can view by mousing over the cell). When you switch the row and the column axes. To do so. the sum is performed on the parents that are placed in the outer and the inner dimension. When you move the row axis on the other side of the data grid using the shift feature in the Report Editor. To do so. In a nested axis. You can then enter data on the children and the sum is calculated on the parent nodes. select the Show Unauthorized Cell Text option. select EPM > Options > Sheet Options and select Clear Data on the Whole File when Saving it.Sheet Options USD . To display a text in the report cells.3. connections. To do so. the cells containing data that you are not authorized to view are left blank by default. select EPM > Options > Sheet Options and select Refresh Data on the Whole File when Opening it. 20. version for SAP NetWeaver. when saving it. 20. To do so.Net Equity A sum formula is added on each node of the hierarchies. The text that is displayed is defined in the Unauthorized Cell Text field in the User Options.4 Clear Data on the Whole File when Saving it You can specify that all the data is cleared from the reports contained in the whole workbook.3.US Dollar All FC00-Opening FC01 . If you are using a model on which security on data has been defined.Net Equity 60 15 45 90 25 65 All All FC00-Opening FC01 . 151 2013-09-04 . when opening it.3.3 Refresh Data on the Whole File when Opening it You can specify that all the data is refreshed for all the reports contained in the whole workbook. in a report.5 Show Unauthorized Cell Text Applies to: Planning and Consolidation. 20. 6 Apply only Report Editor Definition for Faster Refresh If you work with large reports that contain a lot of members. If you move the referenced member to another cell. the formula is not dynamic and actually references the member cell. Related Topics • EPMAxisOverride • EPMDimensionOverride 20. it is saved in the report definition.Sheet Options 20. You must select this option before performing an expand or collapse. Also. to restore the dynamic selection. When you open the Member Selector. each time you refresh the report. see the note below): • If you insert Microsoft Excel empty rows and columns and then refresh the report.3. you perform a dynamic selection and select the member Europe with the Member and Children relationship. Any manual modification in a report is just ignored (except for the expand and collapse action. the Microsoft Excel formula will still reference the initial cell. • If you create Microsoft Excel formulas that reference a member. the selection becomes static (you can check this by opening the Member Selector). For example. and for which the refresh time is too long. refresh the report: the report is restored with the dynamic selection.3. Note: • • When you perform an Expand or Collapse on a member. Any other merged cells are left merged. When you perform a collapse on one of its children in your report. However. 152 2013-09-04 . column axis and data grid cells are unmerged after a refresh. here is how merged cells behave after a refresh: Only the row axis. the dynamic selection is automatically broken. When this option is selected. you can select the Restore Dynamic Selection on Refresh after Navigation option in the Refresh tab of the Sheet Options. you can select the Apply only Report Editor Definition for Faster Refresh option in the Sheet Options. the EPMDimensionOverride and EPMAxisOverride functions cannot be used when this option is selected. However.7 Restore Dynamic Selection on Refresh after Navigation When you perform an expand or collapse. the reports are refreshed much faster. the empty rows and columns are deleted. not the member. it is displayed as it is defined in the Report Editor. as a consequence. you can see that the Expand or Collapse has been kept. Once you have performed an expand or collapse. and not the member/data. and axis shared between several reports. Calculate Parents in Hierarchies option. Consequently.Sheet Options Note: If you open the Report Editor or the Member Selector and click OK.3. namely if you use the following features: Keep Formula on Data option. when you create a Microsoft Excel formula that references a report cell. the Microsoft Excel formula will still reference the initial cell. The report layout must remain static. and you then perform a refresh. 153 2013-09-04 .8 Keep Formulas Static that Reference Report Cells If you use Microsoft Excel formulas that reference the cells (data or member) of a report. #REF will not be displayed in the cell instead of the formula. you can select the option Keep Formulas Static that Reference Report Cells in the Sheet Options. If you select this option. this is the standard EPM add-in behavior. #REF will be displayed in the cell instead of the formula. the current report definition (inluding the static selection) is saved and therefore the dynamic selection is not restored. Note: If the Keep Formulas Static that Reference Report Cells option is selected. it is recommended that you do not move your report. • If the referenced member or data is moved to another cell after a refresh. 20. • Also. if you have chosen a context member selection for a dimension in your report and you change the context member using the EPM Context bar. and if you want those formulas to be static. In the case where you do not select the Keep Formulas Static that Reference Report Cells option. you cannot use the Apply only Report Editor Definition for Faster Refresh sheet option (the option is greyed out) and selecting the Refresh only Expanded and Inserted Members user option will not be taken into account. the formula is not dynamic: it references the cell itself and not the cell content. Sheet Options 154 2013-09-04 . To enable the warning message.1 Going Back in the Navigation Actions The Back command will undo up to five of the most recent EPM add-in navigation operations that you have performed on your Microsoft Office Excel spreadsheet. you can specify that a message warn you that the operation will break the dynamic selection. Click Cancel to cancel the keep operation. and you perform a keep on one of its children in your report. the keep operation is performed but the dynamic selection is broken. layout change. Note: When you perform an expand. even in the case where axes are shared between several reports: • Expand • Collapse • Keep Member • Exclude Member Note: The four operations above do not apply to Microsoft Office Word nor to Microsoft Office PowerPoint. or another EPM add-in operation on any spreadsheet. Row and column axes switch. if you select the member Europe with the Member and Children relationship. Member Selector changes. Report Editor changes.Report Navigation Report Navigation You can navigate in a report. 21. select the Warn if Navigation will Break Dynamic Selection option in the User Options. your Microsoft Office Word document or your Microsoft Office PowerPoint presentation. Refresh data. collapse or keep operation. the message appears. If you click OK. It will persist (be enabled) on a spreadsheet until you do something else on the same spreadsheet using Excel. The Back navigation action can be executed from the ribbon. EPM pane changes. The Back command can undo the following navigation operations. • • • • • • Entering a member when the Member Recognition is activated. or refresh of the cube that was done in error or gave you undesirable results. Its purpose is to let you immediately back out of a navigational action. For example. 155 2013-09-04 . or display only members at level 2. click the button located between the Row Axis and Column Axis areas in the EPM pane or right-click in the report and select EPM > Switch Axes. a dialog box opens and you can define the levels you want to display and if you want to include the selected member or not. To specify the expansion relationship behavior you want to apply by default. 156 2013-09-04 .2 Row and Column Axes Switch You can invert the row and the column axes of a report. the button is deactivated. drills down to the members below (depending on the expansion relationship behavior chosen) and all occurrences of the same member. you must select the Apply Custom Expand option. using the Expand button list. if you select the Enable Double-Click option in the User Options.Report Navigation 21. For example. the fastest way to perform an expand is to double-click on the member you want to expand. you can select other behaviors. The option selected is applied by default: • When you click the Expand button in the EPM tab. the criteria will be lost. This allows you to quickly drill down to find what you are looking for. You cannot switch the row and column axes of a report that shares an axis with another report. select an option in the Expand Options area in EPM > Options > Sheet options > General. In this case. So that the selection is taken into account. You can perform an expand on: • the children of the selected parent and the parent itself • the children of the selected parent • the descendants of the selected parent and the parent itself • the descendants of the selected parent You can also define a custom expand. you can drill down to all members at level 4. To switch the report axes. However. Note: • • A message indicates that if you have defined sorting.3 Expand The Expand command on a member selected in a report. • Also. 21. Note: When you select Custom Expand. the same as in the sheet options that are listed above. The expand action automatically refreshes the report after it has expanded. ranking or filtering criteria in the report. Caution: Review the following restrictions before using this option: • • Do not use this option if the axis on which the expansion/insertion is performed. to expand on the USA member in the row axis. Indentation is an option. When the data sorting. the expand works in the column axis only if the following options are selected in the Expand Options area in the Sheet options dialog box: • • Member and Children Member and Descendants The Expand does not work in the column axis when the other options are selected. the Expand never works in the row axis. Totals are put at the bottom but you can change them into totals at the top. you can specify that only the new inserted rows or columns are refreshed after a member insertion. contains local members. or you can double-click on the USA cell shown here: This will expand USA to display all of its children like this: Note that the children are shown indented above their "total" parent. ranking and filtering are activated. ranking and filtering are activated. select the user option Refresh only Expanded and Inserted Members. The other row and column data is not refreshed. When the data sorting. 157 2013-09-04 . contains EPMInsertCellsBeforeAfterBlock functions. When the data sorting. you can select the USA cell and then click Expand. Do not use this option if the axis on which the expansion/insertion is performed. In Large Reports: Refreshing only Expanded or Inserted Members If you work with large reports and want to accelerate the refresh time.Report Navigation In this example. Note: • • Expand does not work on a page axis dimension member since it has no place to expand to. ranking and filtering are activated. To do so. This behavior also applies to the expanded members (see Expand). the way the Expand works also applies to the Collapse feature. 2012. This is called symmetrical expand. (see example 3) The expand action automatically refreshes the report after it has expanded. see Dynamic Formatting Template Definition. This is called asymmetrical expand. The following members are now displayed: 2010.1 Expand on Nested Axis In a multidimensional (nested) axis. the following members are displayed for the Time dimension: 2010.Report Navigation • This option can cause some formatting settings to not be properly applied. 2012. Example: The Refresh only Expanded and Inserted Members option is selected. For example if you expand on Chips below to show its children (Regular Chips and Sun Style): You get the following: Example 1 158 2013-09-04 . (see example 1) In a multidimensional (nested) axis. Note: This option enhances performances but note that not all displayed data is refreshed in the report after a member insertion. This is the default behavior. The data is refreshed only for the members you have just inserted: 2011. 2011. you can have one of the following behaviors: • • all child members will be repeated for each member of the outer dimension. Related Topics • Expand Options 21. the behavior is the same as in a simple axis. if you expand on an inner dimension. For more information. You insert the 2011 member (right-click in a cell that belongs to the axis that contains the Time dimension and select EPM > Insert Members). (see example 2) only the child member for the selected member of the outer dimension will be displayed.3. if you expand on an outer dimension. In a report. For example. uncheck the option. If you want to perform symmetrical expand and out. you get the following: Example 2 159 2013-09-04 .Report Navigation The Expand/Collapse on Single Member option in the EPM > Options > User options dialog box enables you to perform asymmetrical expand and out on a nested axis. if you expand on an inner dimension. if you expand on Qtr1 (shown above). Note: This option is not specific to any sheet but applies to any use of the EPM add-in. Changes to this option will persist when Microsoft Office Excel is closed and reopened. the changes are applied to all occurrences of this dimension. Using symmetrical mode. Note: This user option is not specific to any sheet but applies to any use of the EPM add-in. the changes are applied only to the selected member cell. 160 2013-09-04 . if you expand on 'Qtr1' in 'Regular Chips' (shown previously). 21. Using asymmetrical mode. Changes to this option will persist when Microsoft Office Excel is closed and reopened. when you double-click a parent member. You can also use the asymmetrical expand by selecting the Expand/Collapse on Single Member option in EPM > Options > User options. when you click the Collapse button in the EPM tab of the ribbon.Report Navigation The months Jan. Note: You can perform a double-click when you select the Enable Double-Click option in the User Options. For example.4 Collapse The Collapse command does the following: • • Collapses to the parent of the child member selected in the report. Collapses to the selected parent member. you get the following: Example 3 The months Jan. Feb and Mar have been added in all places. if you expand on an inner dimension. Feb and Mar have been added only for Regular Chips. This saves you from having to repeat the same changes throughout the report layout. This enables you to eliminate unnecessary cells throughout the report layout. the behavior is the same as in a simple axis. 161 2013-09-04 . This is possible only when a single member is selected for a dimension located in the page axis. The collapse action automatically refreshes the report after it has collapsed. the Collapse does not work in the column axis when the other options are selected. ranking and filtering are activated.Report Navigation When you perform a collapse. if you collapse on an outer dimension. the Collapse never works in the row axis. the Collapse works in the column axis only if the following options are selected in the Expand Options area in the Sheet options dialog box: • • Member and Children Member and Descendants When the data sorting. Florida.1 Collapse on Nested Axis In a multidimensional (nested) axis. The collapse feature enables you to quickly collapse to the top of a hierarchy. When the data sorting. Combined with the expand feature. all descendants of the parent of the selected member are removed. For example. 21. This collapses Florida (and the rest of the States) to its parent (USA) like this: When the data sorting. Collapse as a Way to Select the Parent Member You can also use the Collapse on a member cell located in the page axis of a report: the parent member is displayed instead and is taken into account in the report. you can select any child of USA (for example.4. ranking and filtering are activated. if you want to collapse to the USA member in the row axis. ranking and filtering are activated. as shown below) and then click Collapse. you can move up and down very easily. The member you select must be a member that is part of an axis but can be applied to either the row or column axes. Changes to this option will persist when Microsoft Office Excel is closed and reopened. then you can have one of the following behaviors: • • all child members will be removed for each member of the outer dimension. uncheck the Expand/Collapse on Single Member option in EPM > User > User Options. This is called symmetrical collapse. more than one level has been removed (the months and the quarters) since you collapsed on a quarter (Qtr2). 162 2013-09-04 . you have the following: Example 1 Notice that it does not matter which group you select. (See example 2) If you want to perform symmetrical collapse and out. The collapse action automatically refreshes the report after it has collapsed.Report Navigation In a multidimensional (nested) axis. (See example 1) only the child member for the selected member of the outer dimension will be removed. Also in this example. If you collapsed on Qtr2 in Sun Style: In symmetrical mode. This is the default behavior. Note: This general option is not specific to any sheet but applies to any use of the EPM add-in. This is called asymmetrical Collapse. if you collapse on an inner dimension. This enables you to quickly keep what you are interested in analyzing further. if you want to keep Qtr2 and Qtr3 in the row axis.Report Navigation You can use the asymmetrical collapse by selecting the Expand/Collapse on Single Member option in the dialog box that you can access by selecting EPM > Options > User options. since you collapsed on a quarter (Qtr2) in Sun Style. For example. This action automatically performs a Refresh of the report. you have the following: Example 2 In this example. This navigation action can be executed by clicking Keep in the EPM tab of the ribbon. All other members are excluded. They must be members that are part of an axis. but the Keep command can be applied to either the column or row axes. In asymmetrical mode.5 Keep Member The Keep command keeps all occurrences of the selected members including all occurrences in an inner nested dimension. 163 2013-09-04 . you select both of them (using the Shift or Ctrl keys) and then click Keep. only the months and the quarters on Sun Style have been removed. 21. the Keep command is applied to all occurrences of the selected members in a multidimensional axis as in the above example. you can select separate members (such as Qtr2 and Full Year). the selected members do not need to be adjacent cells. The members must be part of an axis. If you want to keep. You can also select Keep/Exclude on Single Member in EPM > Options > User Options.6 Exclude Member The Exclude command leaves out all occurrences of the selected members including all occurrences in an inner nested dimension. for example.Report Navigation This will keep only Qtr2 and Qtr3 like this: Note that it does not matter which occurrence of Qtr2 and Qtr3 you select. Furhtermore. Note: This user option is not specific to any sheet but applies to any use of the EPM add-in. but leave the rest as is. All other members are kept. Changes to this option will persist when Microsoft Office Excel is closed and reopened. Like Expand and Collapse. but this command can be applied to either the row or column axis. Related Topics • Asymmetric Report Creation 21. 164 2013-09-04 . you can simply delete the unwanted lines using Microsoft Office Excel. Qtr2 and Qtr3 in one of the groupings. using the Ctrl key. and the selection is persistent for the current report. which is sometimes easier than performing a Keep.Report Navigation The excluded members automatically appear in the Excluded Members tab of the Report Editor. Changes to this option will persist when Microsoft Office Excel is closed and reopened. The selected members do not need to be adjacent cells. If you want to exclude Qtr1 and Qtr2 in one of the blocks. This excludes Qtr1 and Qtr2 and leave you with this: Note that it does not matter which occurrence of Qtr1 and Qtr2 you select. you select both members (using the Shift or Ctrl keys) and then click Exclude. This enables you to quickly exclude what you are not interested in analyzing further. the Exclude command is applied to all occurrences of the selected members in a multidimensional axis . This navigation action can be executed by clicking the Exclude button in the EPM tab of the ribbon. Using the Ctrl key.as in the above example. if you want to exclude Qtr1 and Qtr2 in the row axis. Like Expand and Collapse. You can also select EPM > Options > User Options and select the Keep/Exclude on Single Member option. Note: This user option is not specific to any sheet but applies to any use of the EPM add-in. 165 2013-09-04 . but leave the rest as is. you can simply delete the unwanted lines using Microsoft Office Excel. you can select separate members (such as Qtr2 and Full Year). For example. This action automatically performs a Refresh of the report. collapse and page axis selection. However. Changes to this option will persist when Microsoft Office Excel is closed and reopened.7 Double-Click Actions The double-click command allows you to control whether or not the EPM add-in assumes control over the mouse double-click in Microsoft Office Excel. select Enable Double-Click in EPM > Options > User Options. If you are using other functionality or add-ins in Microsoft Office Excel that require the double-click then you should disable this. • You will be able to use the EPM functions that require double-click actions.Report Navigation Related Topics • Asymmetric Report Creation • Excluding Members 21. if you enable double-click actions for the EPM add-in: • You will have quick access to three very useful features: expand. Note: This user option is not specific to any sheet but applies to any use of the EPM add-in. To enable double-click actions. Related Topics • Expand • Collapse • Page Axis Dimension Members Modification using the Member Selector • EPM Functions 166 2013-09-04 . A web browser opens.com/search? • URL parameter 1: member description for the Account dimension. then select the command from the ribbon. • In some cases. Drill-through definitions are previously set up in the Planning and Consolidation Administration view. Drill-through to URL A drill-through to URL enables you to display information in a web browser. Note: If the cell you have selected in the worksheet is out of the report. the data cell that you selected in the report. • URL parameter 2: 2010. 167 2013-09-04 .Drill-Through Drill-Through Applies to: Planning and Consolidation connections. depending on the cell you select in the report. select a cell that belongs to the report. The information displayed depends on the following items: • The URL that was previously specified in the Administration view. the search is performed on 2010. a command appears inEPM > Drill Through > Drill Through to URL. Example for a Google search on the account member description. For example: a Planning and Consolidation web report. a BEx report. an error message appears. The time period is hard-coded. Note: The URL and the URL parameters appear in the browser address bar. for any URL and specific parameters that have been specified in the Administration view. if a drill-through to URL has been defined in Planning and Consolidation Administration on this model.google. There are two types of drill-through: drill-through to URL and drill-through to table. Even if the report contains data on 2009. As soon as you are connected to a Planning and Consolidation model. The drill-through feature enables you to view information on source data that make up the content of a selected cell in a report in Microsoft Office Excel. a google page. the URL to the SAP BusinessObjects Financial Information Management server (this particular case is called: Drill through to origin). To access the drill-through information. The drill-through definition has been set up as follows in the Administration view: • URL: http://www. • The URL parameters that were previously specified in the Administration view. The member description will vary. The command is named after the description entered in Planning and Consolidation Administration. the web browser or sheet opens and displays the table for Actual data. Note: Even if the selected cell does not contain any data. version for the Microsoft platform. When you connect to a Planning and Consolidation model. when you view the drill-through information. • The data cell that you have selected in the report. In a report: • when you select a data cell for the Actual member. then select one of the drill-through to table commands. To access the drill-through information. the web browser opens and the results of the Google search on the "Advertising+Costs+2010" terms are displayed. the drillkey property has been added to the Actual member of the Category dimension. then select one of the drill-through to table commands. a dialog box appears prompting you to select the dimension for which you want to view the information. Depending on the link selected. if a drill-through to table has been defined in Planning and Consolidation Administration on this model. a message appears. You can display the table either in a web browser or in in a Microsoft Office Excel sheet. A drill-through to table enables you to display information from external databases or the Journals database.Drill-Through In a report: • when you select a data cell for the Account member "Operating Costs". then select the drill-through to URL command. the drill-through information is displayed in a web browser or in another sheet of the current workbook. two commands appear inEPM > Drill Through > Drill Through to Table. The information displayed depends on: • The drillkey properties that have previously been specified in the Administration view. Example for viewing information from an external database on the Actual member of the Category dimension. a message appears. • when you select a data cell for the Budget member. and the name of a query file has been specified. In the Administration view. Note: If several drillkeys have been defined on several dimensions. Then click one of the two commands in the Drill Through to Table command in the ribbon. indicating that no drill-through information is available. Note: If the cell you have selected in the worksheet does not correspond to any member for which drillkeys have been defined. A drillkey is defined for one or more members for a specific dimension. the drill-through is performed. for a specific query file and specific properties (called drillkeys) that have been specified on dimension members in the Administration view. connections. Drill-through to table Applies to: Planning and Consolidation. then select the drill-through to URL command. 168 2013-09-04 . select the appropriate cell. the web browser opens and the results of the Google search on the "Operating+Costs+2010" terms are displayed. indicating that no drill-through information is available. • when you select a data cell for the Account member "Advertising Costs". Drill-Through Note: For more information about drill-through setup, see the SAP BusinessObjects Planning and Consolidation help. 169 2013-09-04 Drill-Through 170 2013-09-04 Quick Links Quick Links You can create quick links in a report to another report contained in another Microsoft Excel workbook, Microsoft Word document or Microsoft PowerPoint presentation. Quick links can be used to guide you through ad-hoc analysis. You can define thee types of quick links, depending on your analysis needs: • Quick link defined on specific data. The linked workbook inherits the definition of the selected data cell, according to the following priority order: • Members at the cell intersection, meaning the member in the row axis and the member in the column axis (or several members in the case of nested dimensions). • Members in the page axis. However, if several members are selected for a dimension in the page axis, the context is taken into account as a priority for this particular dimension. • Members in the context. • Quick link defined on a specific member. The linked workbook inherits the definition of the member cell, according to the following priority order: • The selected member (or several members in the case of nested dimensions). • Members in the page axis. However, if several members are selected for a dimension in the page axis, the context is taken into account as a priority for this particular dimension. • Members in the context. Quick link defined on the current report. The linked workbook inherits the definition of the report, according to the following priority order: • Members in the page axis. However, if several members are selected for a dimension in the page axis, the context is taken into account as a priority for this particular dimension. • Members in the context. • Note: Since a link is always attached to a combination of members and not to a specific cell or cell range, if you move the members in the report, the links follow. If you have defined a link to another workbook, the linked workbook opens in a new instance of Microsoft Excel (the latest modification that you have made in the user context in the first workbook are taken into account). Precedence rules: a quick link defined on data takes precedence over a link defined on a member, which takes precedence over a link defined on the whole report. The workbooks to be opened using the quick links can be located on: • the Planning and Consolidation server • another location 171 2013-09-04 Quick Links You can select the workbook location in the User options dialog box. If you select the Planning and Consolidation Server option, when creating a quick link and specifying the workbook to be opened, the server file selection dialog box opens. If you select the Local option, when creating a quick link and specifying the workbook to be opened, the standard file selection dialog box opens. Symbols with default color-coding differentiate quick links defined on specific data and quick links defined on a specific member. You can change the colors in the User options dialog box. You can hide the quick link symbols by clicking the Show Link Symbols button. Note: • • When the symbols are hidden, the quick links are not active and therefore cannot be clicked on. After clicking the Show Link Symbols button, you must perform a refresh. You can open a linked workbook by clicking a quick link symbol or by clicking the link that appears in the EPM pane. The link that appears in the EPM pane depends on the selected cell in the report since the precedence rules apply. 23.1 Creating Quick Links 1. Depending on your analysis needs, select a data cell, a member cell or any cell in your report and click Quick Links in the ribbon, then select one of the following commands: Add Cell Link, Add Member Link or Add Report Link. Note: You can also right-click on a cell and select the apropriate command from the EPM menu. The file selection dialog box opens. Note: In the User options dialog box, if you have selected the Planning and Consolidation Server option, the server file selection dialog box opens. 2. Select the workbook to which you want to link. If the Quick Links > Show Link Symbols command is activated, the following symbols are displayed: • • For a data link, the symbol — red by default — appears in the selected cell. For a member link, the symbol — blue by default — appears in the cell of the selected member. Note: If the Quick Links > Show Link Symbols command is not activated, select it and perform a refresh so that the link symbols are displayed in the report. 23.2 Deleting Quick Links 172 2013-09-04 Quick Links • Depending on the type of link you want to delete, select a data cell, a member cell or any cell in your report and click Quick Links, then Delete Data Link, Delete Member Link or Delete Report Link. 173 2013-09-04 Quick Links 174 2013-09-04 Custom Members Custom Members Applies to: Local and SAP BusinessObjects Enterprise connections. Caution: Creating custom members may lower system performance. You can create members for calculations on a specific sheet/connection pair. These members are called "custom members". Custom members are not stored in the cube/model, they are created only for a sheet/connection and can be shared with other users by sending the sheet. Custom members have the same behavior as any other member on the sheet. Custom members enable you to create simple calculations such as differences or relative periods. They also enable you to create MDX queries. You can either create a custom member in the dedicated dialog box or convert a local member into a custom member. • Custom member creation. Custom members are manually created in the Custom Member Editor dialog box, which provides all MDX functions. When you insert a function, the whole syntax is provided. You just need to insert the appropriate parameters inside the quotation marks. You can use a button to insert dimension members. Auto-completion enables you to insert functions, dimensions, hierarchies and dimension members. • Color coding. Reading formulas is made easier with color coding. MDX functions, dimension members and punctuation characters are displayed in different colors. • Auto-completion. • For MDX functions: enter the first character of a function, then enter Crtl + Space. A contextual menu automatically appears, displaying the list of MDX functions. • For dimensions, hierarchies and dimension members: enter [. A contextual menu automatically appears, displaying the list of elements available, depending on the location in the formula. Note: A tooltip displays the name of a member used in a formula. Restriction: When connected to an SAP NetWeaver BW cube, the following custom member features are not supported in the Expression area of the Custom Member Editor dialog box: auto-completion, color coding and tooltip that displays the name of a member used in a formula. • Custom members converted from a local member. To convert a local member into a custom member, right-click on the local member in the report and select EPM > Convert to Custom Member. 175 2013-09-04 Custom Members Tip: Each time you select several dimension members for a page axis dimension, the total of the members is calculated. If you often use a specific selection of members for a page axis dimension and if you want to reuse it in other reports for the same sheet/connection pair, you can create a custom member. Not all local members can be converted into custom members. The following functions and operators are supported: • +, -, *, / • MIN, MAX, MEDIAN • COUNT • SUM, AVERAGE • abs • >, <, = • AND, OR • IF, ISBLANK Note: If you change the connection of a report, the EPM add-in merges all of the custom members (from the previous and the new connection). If two custom members have the same name, the custom member of the previous connection is deleted. Once created, a custom member behaves like any other member. It can be displayed in the sheet by selecting it along with other members in the Member Selector dialog box, or by entering it completely or partially in a cell (if the Member Recognition is activated, the member is recognized). A custom member can be deleted, but it can also be deactivated and then reactivated. Note: Limitations: • You cannot create a local member based on a custom member. • Custom members are not displayed for selection in the EPM Context pane. Related Topics • Member Entry Using the Member Selector • Local Members 24.1 Creating custom members 1. Select EPM > Custom Members > Manage Custom Members. The EPM - Custom Member Manager dialog box appears. 2. Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. 3. Select the sheet/connection pair for which you want to create the custom member. 176 2013-09-04 Custom Members 4. Click the Add button. The Custom Member Editor dialog box appears. 5. In the Name field, enter a name for the custom member, such as it will appear in the sheet. 6. Click the Choose Dimension button. The Dimension Selector dialog box opens. 7. Select the dimension for which you want to create the custom member. 8. Click the OK button. 9. In the Custom Member Editor dialog box, in the Expression field, enter the expression that will perform the calculations you want. To insert a function, drag and drop an MDX function from the MDX Functions section to the Expression section. Tip: To display all the MDX functions, check the Show all functions option. To insert a dimension member inside parameter quotation marks, select the parameter, then click the Insert Member button. To insert functions, dimensions, hierarchies and dimension members, use the auto-completion function by entering specific characters. See Custom Members. 10. Click the Check Syntax button to check if the expression is correct. Tip: To delete the expression, click the Clear Expression button. 11. Click the OK button. Related Topics • Custom Members 24.2 Custom Members Order When you create more than one custom member, it is very important that you order them according to the calculations order you want. You can define the order you want by using the arrow buttons on the right-hand side of the Custom Member Manager dialog box, which you can access by selecting EPM > Custom Members > Manage Custom Members. 177 2013-09-04 [All].[2002] "Net profit / Profit b.[All]. The information in the Custom Member Editor is as follows: • • • • Name: Variance Dimension: Period Expression: [Period]. calculates the 2003 variance compared to 2002. the result (-2%) is as follows: 178 2013-09-04 . The information in the Custom Member Editor is as follows: • • • Name: Net profit / Profit b.[Period].Prof from ordinary ativities]. the result (98%) is as follows: • If you choose the order Net Profit/Profit by tax and then Variance.[1-PL-Profit and Loss]. Tax".[TR800 .Group profit before min int].[TR500 .[All]. Tax Dimension: Accounts Expression: [Accounts]. based on the Period dimension.[2003]. calculates the net profit percentage compared to profit before tax.[TR800 .[1-PL-Profit and Loss]. the resulting calculation in the cell at the intersection of the two members is different.Custom Members Example: Create two custom members • "Variance". based on the Account dimension.Net Profit]/[Accounts].[All].[TR600 .[TR700 .Net Profit].Profit before tax] Depending on the order you chose for the custom members. • If you choose the order Variance and then Net Profit/Profit by tax. 179 2013-09-04 . 3. The EPM . Select EPM > Custom Members > Manage Custom Members . You will be able to select the custom members in the reports. 2.Custom Members 24. Select EPM > Custom Members > Manage Custom Members . 24. The EPM . Click the OK button. 7. Click the Edit button. 5.5 Deleting Custom Members 1. Select EPM > Custom Members > Manage Custom Members. 24. 3. But you may want to enable them again later on. 5. click the Disable All button. Select the sheet/connection pair for which you want to enable or disable the custom members.Custom Member Manager dialog box appears. Click the OK button. You will not be able to select the disabled custom members in the reports. 2. 4.Custom Member Manager dialog box appears. • To disable custom members. The Custom Member Editor dialog box appears. The EPM . Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. Select the custom member you want to modify.4 Enabling or Disabling all the Custom Members Defined for a Sheet/Connection 1. Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. click the Enable All button. Select the sheet/connection pair for which you want to modify the custom member. 6. Make the changes you want.3 Modifying Custom Members 1.Custom Member Manager dialog box appears. Choose one of the following: • To enable custom members. 4. for convenience. in addition to the custom member names. 2. Select EPM > Custom Members > Export Custom Members. collapse to the sheet level or collapse to the connection level. • To delete all the custom members. You can display the formulas defined in the custom members by clicking the Show Details button.. Click the OK button. You can use the expand and collapse features. they can be imported in other reports. • 3. click the Delete All button. Choose one of the following: • To delete one specific custom member.1 Exporting Custom Members 1..The export can be performed for several EPM sheets and connections at the same time. 5. 180 2013-09-04 .6 Custom Members Export Custom members can be exported and stored in . and expand all the items. 4. Once the custom members are stored in a file. select it. then click the Delete button. You can choose the way you want to display them: by sheet or by connection. • • • • For convenience.Custom Member Export Wizard appears. you can use the menu displaying a + icon. Check the boxes corresponding to the custom members you want to export. You can also display the formulas defined in the custom members. You can also re-use the formula for other purposes. sheets and custom members are displayed in a tree view. Tip: • When the dialog box displays a certain number of items. Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. A dedicated wizard enables you to export custom members. 24. The EPM . 3. Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. 24.xml files.Custom Members 2. Select the sheet/connection pair for which you want to delete the custom members.6.. the connections. A message appears. you can choose to replace them by the one you are importing. Click the Next button. • If the custom members already exist. A dedicated wizard enables you to import custom members. 181 2013-09-04 . In the next screen of the wizard. click the Select All button. you must choose the sheet/connection pairs where you want to import the custom members. click the Show only errors button. In the File Name area. Click the OK button. 24. Once you have selected from the file the custom members you want to import. 5. Custom members with errors are indicated by a red cross. 4. • • • • For convenience. sheets and custom members are displayed in a tree view. Click the Finish button. You can choose the way you want to display them: by sheet or by connection. Target Sheets/Connections.Custom Members Tip: To select all the members at the same time. Tip: To display only custom members with errors.7 Custom Members Import You can import custom members that are stored in an XML file. In this screen. You can also display the formulas defined in the custom members. enter the path and the name of the file to which you want to export the custom members. informing you whether or not the export was successful. The Source Custom Members screen of the wizard is the same as for the custom members export. select the Replace custom members if exist option. 7. you choose the sheet/connection pairs where you want to import the custom members. the connections. They are not imported. To do this. in addition to the custom member names. 6. you can see if there are errors on any of the custom members. Syntax Check. In the next screen of the wizard. you choose the custom members you want to import. You can use the expand and collapse features. informing you whether or not the import was successful. Click the Next button. 8. The EPM . click the Show only errors button. Click the OK button. Tip: To only display custom members with errors. If the custom members already exist.. 6.7. 2.. 3. A message appears. Check the boxes corresponding to the custom members you want to import. Click the Next button. Click the Next button.Custom Member Import Wizard appears.Custom Members 24. 11. The ones with errors are indicated by a red cross. you can use the menu displaying a + icon. They will not be imported. Tip: To select all the members at the same time. 4. The next screen of the wizard displays the status of the custom members.1 Importing Custom Members 1. 7. you can choose to replace them by the one you are importing by selecting the Replace custom members if exist option. SelectEPM > Custom Members > Import Custom Members. and expand all the items. collapse to the sheet level or collapse to the connection level. click the button and select the path and the file containing the custom members you want to import. The next screen of the wizard displays the sheet/connection pairs where you can import the selected custom members.. In the File Name area. You can display the formulas defined in the custom members by clicking the Show Details button. Click the Finish button. The next screen of the wizard displays the custom members contained in the file. Choose how you want to display the sheet/connection pairs by clicking the Display by Sheet or Display by Connection button. 10. click the Select All button. 182 2013-09-04 . • 5. Check the boxes corresponding to the sheet/connection pairs where you can import the selected custom members. 9. for convenience. Tip: • When the dialog box displays a certain number of items. follow these steps: • If you want to retrieve data. It is installed as an add-in to SAP BusinessObjects Dashboard Design. Even though the user options Display EPM Context Bar and Display EPM Pane are selected. EPM connector is a component of the EPM add-in. You can design a dashboard and export it to Flash format in SAP BusinessObjects Dashboard Design. Note: For more information about exporting a dashboard to Flash. see the Dashboard Design user guide Related Topics • Flash Object Insertion 183 2013-09-04 . the two following EPM add-in interface areas are not displayed: the EPM Context bar and the EPM pane. To design a dashboard.Flash Objects Flash Objects By inserting Flash objects (files with the . the bar and the pane remain hidden. You specify the type of data. 25. Note: • When you open the EPM add-in via SAP BusinessObjects Dashboard Design. using EPM Connector Applies to: Local or SAP BusinessObjects Enterprise connections. You can design a dashboard and export it in Flash format. Word or PowerPoint. create a report using the EPM add-in. using EPM Connector.swf extension). You can then insert the Flash object in a report in Microsoft Office Excel. • To create a dashboard and export it to Flash format. • Create and configure a connection using EPM Connector. in SAP BusinessObjects Dashboard Design. you can perform a powerful and graphical analysis of your reports and what-if analysis. you must be familiar with the Dashboard Design application and functionality. insert the appropriate components in the dashboard and link the data to the dashboard components. using the EPM add-in.1 Flash Object Creation. • You can export the dashboard to Flash. version for SAP NetWeaver: • Input and save data. Note: To be able to enter data on a model. • SAP BusinessObjects Planning and Consolidation. All the connections are created on the EPM Connector connection type. cube designer. • Retrieve the list of cubes/models/InfoProviders for a specific database/environment/InfoArea. Creating a connection consists of the following steps: • Entering a name for the connection. in the Data Manager dialog box of the Dashboard Design application. version for the Microsoft platform.1. 184 2013-09-04 . • Retrieve the list of databases/environments/InfoAreas for a specific data source. You can retrieve data and metadata from any data source listed below into a Dashboard Design toolset: • SSAS cubes created with SAP BusinessObjects Financial Consolidation. Depending on the operation type you choose.1 Connections and Operations Connections Each operation is specified in a connection. models. • SAP BusinessObjects Planning and Consolidation. • Retrieve Business Process Flows. • Selecting the application to which you want to connect. Operations You can perform the following operations and combine them: • Retrieve data. version for SAP NetWeaver. version for the Microsoft platform. • Retrieve members/characteristic values for a specific dimension. • SAP BusinessObjects Planning and Consolidation. you must select the Use as Source of Data for External Applications option for a model in the Administration view. • SAP BusinessObjects Planning and Consolidation. • Retrieve the list of dimensions for a specific cube/model/InfoProvider. using a report created with the EPM add-in. for the following: • SAP BusinessObjects Profitability and Cost Management models. you configure the connection with different information. You can also enter and save data using a Dashboard Design toolset. version for the Microsoft platform and SAP BusinessObjects Planning and Consolidation. • SAP NetWeaver BW InfoCubes created with SAP BusinessObjects Financial Consolidation. models. cube designer. models. models. version for SAP NetWeaver. • Entering the host name. The following operation types are only available for SAP BusinessObjects Planning and Consolidation. The Data Manager is a centralized location where you can add and configure all external data sources.Flash Objects 25. • • Some behaviors and areas are common to all the operations. version for the Microsoft platform. you can enter the beginning of the item you want to select. enter the URL to the XMLA provider. 185 2013-09-04 . depending on other filled in areas. Select the application you want to connect to by selecting it from the Application list. The dropdown lists identified by a hand icon enable you to select or automatically retrieve items: • Bind enables you to select a cell in the sheet. The connection created is called by default "Connection [number]". 25. The syntax is: http://hostname/dat apumpwebdirectory/msmdpump.dll • For SAP BW InfoCubes. if the Cube area is already filled in. 2. • Retrieve automatically retrieves a list of items available for selection. The list is filtered and displays only the items beginning with the characters you have just entered. Note: Some terms differ and are listed and separated by the / character (see above). enter a name for the connection you are creating. 4. 6. Select Data > Connections. • • • Retrieve the list of context members. depending on the source.Flash Objects Note: This operation is only available for SAP BusinessObjects Planning and Consolidation. Retrieve property values for dimension members. to automatically refesh the data before refreshing all the Dashboard Design components. In the home icon area. Retrieve text contained in a text file from the Documents view. 3. Refresh Every [number] Second. enter the URL to the server: • For SSAS cubes. in the Retrieve Dimension Members operation. you can select Retrieve in the Member area and all the available dimensions and members specific to this cube are retrieved and available for selection. to set an automatic refresh frequency. Click Add and select EPM Connector from the list. enter the URL to the Data Pump server. 5. you select two refresh options: • • Refesh on Load.2 Creating a Connection in Dashboard Design 1. In the Name area. In the Ouput section. then press Enter. Features common to the operations • When a dropdown list contains a long list of items. Select the "Connection [number]" created in the connection list. For example. The Data Manager dialog box opens.1. the default report is taken into account. depending on the operation type you choose.3 Retrieve Data Using a Report You can create a connection to retrieve data using a report created with the EPM add-in. identifies the default report. If prompted. 7. If the sheet contains several reports: • If the name of the report you have entered is not correct. the default report is taken into account. enter the URL to the server.Creating a report Before creating the connection. as described further in this documentation.Flash Objects • For Planning and Consolidation models. Other elements can be retrieved. Select the EPM Report operation. This function identifies the whole report using XML and MDX languages. In a cell of the sheet that contains the report. you must re-enter the function.1. 8. The cell reference automatically appears in the home icon area. Step 2 . All the available data sources are automatically displayed in the Data Source list. • If you do not enter the name of the report between the "". Therefore. 25. Note: The =GetReportDefinition() function without anything inside the parentheses. If you create another report on the same sheet. To display the list of all the OLAP server names available (all data sources). as in this example where the report is named sales2008: =GetReportDefinition("sales2008"). you can enter the URL in the data sheet. Configure the connection. click Retrieve in the Data Source dropdown list. in the home icon area. The syntax is: http://server:port/ or https://server:port/ Tip: If you often use the same server URL. using the Dashboard Design Data Manager dialog box. enter the user ID and the password to the server and click OK. Any report identified by the =GetReportDefinition() function must use a local or an SAP BusinessObjects Enterprise connection. including the name of the report inside the parentheses and with quotation marks. 186 2013-09-04 . see Creating a Connection in Dashboard Design. depending on the operation type you choose. Step 1 . you first need to create a report using the EPM add-in. you can click the cell selector button and select the cell in the data sheet. instead of entering the URL.Creating the connection You can create the connection. enter the following function: =GetReportDefinition() This function enables you to link the default report and the connection. so that any error message will be displayed. to filter the data to be retrieved. use the components that you think are the most appropriate to the final Flash object. members in the context.1. use the Dynamic Filters cell selector and select a range of cells in the sheet.[BUDGET] Tip: You can use the Retrieve Dimension Members operation to retrieve members for a dimension in two columns. Depending on the application you have selected.Flash Objects Then.[ACTUAL] [Category]. All the following items for the report are automatically recognized: the name of the report. Note: The Static Filters section includes the page axis members and the context members. If needed. the page axis. To do so. the row axis and the column axis. 187 2013-09-04 . Step 3 . For example: [Category]. select the Retrieve Databases or Retrieve Environments or Retrieve InfoAreas operation. the database. using the Dynamic Filters cell selector. see Creating a Connection in Dashboard Design.Creating the connection To create the connection. one for the names and one for the unique IDs.Using Dashboard Design components Once you have configured the operation. You can also select other members.[H1]. using the Dashboard Design Data Manager dialog box. you can select the column displaying the IDs of members. The range must contain one column containing the IDs and x rows. the cube. To select additional members for the EPM Report operation. including members based on properties. Related Topics • Creating a Connection in Dashboard Design • Retrieve Dimension Members/Characteristic Values 25.4 Retrieve Databases/Environments/InfoAreas You can create a connection to retrieve the databases/environments/InfoAreas for a specific OLAP data source.[H1]. you can also select a cell using the cell selector button in the Message area of the Output section. use the Report Definition cell selector button to select the cell in which you have entered the =GetReportDefinition() function. Step 1. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. then the database/environment/InfoArea for which you want to display the cubes/models/InfoProviders. It is recommended that you select two columns (the first one for the names and the second one for the unique IDs) and a large number of rows. so that all the databases/environments/InfoAreas will be displayed. Select the data source. the recommended components are only suggestions. • Connection Refresh Button. Related Topics • Creating a Connection in Dashboard Design 25. you can also select a cell using the cell selector button in the Message area.1. If needed. select the Retrieve Cubes or Retrieve Models or Retrieve InfoProviders operation. check the box next to the connection you have created.Using Dashboard Design components Note: In this section. In the Properties panel on the right. • Input Text Area (if you have selected a cell for messages to be displayed). Once you have configured the operation. In the Properties panel on the right. In the Properties panel on the right. use the cell selector button to select a destination cell range. Use the components that you think are the most appropriate to the final Flash object. so that the connection is refreshed when clicking the Refresh button. click the Data cell selector button to select the cells in the spreadsheet that will contain the databases/environments/InfoAreas. In the Result area of the Output section. Tip: Apply a color to the selected cells so that you can easily identify them afterwards.5 Retrieve Cubes/Models/InfoProviders You can create a connection to retrieve the cubes/models/InfoProviders for a specific database/environment/InfoArea. Step 2 . see Creating a Connection in Dashboard Design.Flash Objects Select the data source for which you want to display the databases/environments/InfoAreas. Depending on the application you have selected. 188 2013-09-04 .Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. so that any error messages will be displayed. Step 1. click the Link to Cell cell selector button to select the cell in the spreadsheet that will contain the error message text. the recommended components are only suggestions. use the cell selector button to select a destination cell range. Step 2 . Select the Retrieve Dimensions operation. • Connection Refresh Button. Tip: Apply a color to the selected cells so that you can easily identify them. check the box next to the EPM connection you have created. use the cell selector button to select a destination cell range.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. so that any error messages will be displayed. In the Properties panel on the right. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. • Input Text Area (if you have selected a cell for messages to be displayed). you can also select a cell using the cell selector button in the Message area. so that the connection is refreshed when clicking the Refresh button.Flash Objects In the Result area of the Output section. then the database/environment/InfoArea. Step 1. In the Result area of the Output section. It is recommended that you select two columns (the first one for the names and the second one for the unique IDs) and a large number of rows. Tip: Apply a color to the selected cells so that you can easily identify them. so that any error messages will be displayed. Use the components that you think are the most appropriate to the final Flash object. then the cube for which you want to display the dimensions.Using Dashboard Design components Note: In this section.6 Retrieve Dimensions You can create a connection to retrieve the dimensions for a specific cube/model/InfoProvider. 25. In the Properties panel on the right. click the Link to Cell cell selector button to select the cell in the spreadsheet that will contain the error message text. In the Properties panel on the right. If needed. It is recommended that you select two columns (the first one for the names and the second one for the unique IDs) and a large number of rows. 189 2013-09-04 . Select the data source. Once you have configured the operation. you can also select a cell using the cell selector button in the Message area. If needed.1. so that all the dimensions will be displayed. click the Data cell selector button to select the cells in the spreadsheet that will contain the cubes/models/InfoProviders. so that all the cubes/models/InfoProviders will be displayed. see Creating a Connection in Dashboard Design. then the cube/model/InfoProvider for which you want to display the dimension members/characteristic values. Then. In the Properties panel on the right. Depending on the application you have selected. Use the components that you think are the most appropriate to the final Flash object. then the hierarchy for which you want to display the members/characteristic values. It is recommended that you select two columns (the first one for the names and the second one for the unique IDs) and a large number of rows. so that the connection is refreshed when clicking the Refresh button.Using Dashboard Design components Note: In this section. Click the cube/model/InfoProvider. Tip: Apply a color to the selected cells so that you can easily identify them. The member/characteristic value is displayed in the Member area. 190 2013-09-04 . A screen opens. see Creating a Connection in Dashboard Design. Once you have configured the operation.7 Retrieve Dimension Members/Characteristic Values You can create a connection to retrieve the members/characteristic values for a specific dimension. • Connection Refresh Button. Select the option corresponding to the members you want to retrieve: only the member selected. the member selected and its children. specify a member/characteristic value by selecting a cell or select Retrieve from the Member dropdown list. then the dimension.Flash Objects Step 2 . then the database/environment/InfoArea.1. so that all the dimension members/characteristic values will be displayed. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. Step 1. Related Topics • Creating a Connection in Dashboard Design 25. In the Properties panel on the right.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. Select the data source. the recommended components are only suggestions. use the cell selector button to select a destination cell range. In the Result area of the Output section. or the member selected and its siblings. check the box next to the EPM connection you have created. select the Retrieve Dimensions or Retrieve Characteristic Values operation. then double-click a member/characteristic value. the member selected and its ascendants. click the Data cell selector button to select the cells in the spreadsheet that will contain the dimensions. check the box next to the EPM connection you have created. so that any error messages will be displayed. version for SAP NetWeaver.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. so that the connection is refreshed when clicking the Refresh button. Related Topics • Creating a Connection in Dashboard Design 25. then the model for which you want to enter data. the recommended components are only suggestions.8 Input Data Applies to: SAP BusinessObjects Planning and Consolidation. Once you have configured the Display dimension members operation type. the member name. see Creating a Connection in Dashboard Design. then the environment. Select the Input Data operation. The range you reference must contain four columns that include: the dimension name. See Retrieve Dimensions and Retrieve Dimension Members/Characteristic Values . • In the Cell Value area: 191 2013-09-04 . double-click on it.Flash Objects If needed. The member you select must a base member. You can retrieve dimensions and dimension members by using the appropriate operations. Dynamic definition: use the menu and select Bind to reference a cell range in the worksheet. not a node. click the Data cell selector button to select the cells in the spreadsheet that will contain the dimension members/characteristic values. Step 1. You can create a connection to enter data on specific members. the dimension unique ID. In the Properties panel on the right. the member unique ID. version for the Microsoft platform and SAP BusinessObjects Planning and Consolidation. Select the data source. To select a member. Click the ellipsis button and select a member for each dimension. • Connection Refresh Button. you can also select a cell using the cell selector button in the Message area. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. Use the components that you think are the most appropriate to the final Flash object. Step 2 .1. In the Properties panel on the right.Using Dashboard Design components Note: In this section. In the Cell Definition area: • Static definition: use the menu and select Retrieve to retrieve the the list of dimensions. 1. 25.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. If needed. use the cell selector button to select a destination cell range. In the Properties panel on the right. To do so. You can rename the button to "Save" for example. even if no changes are made. You can enter the data you want for the specified members. To do so.9 Retrieve Business Process Flows Applies to: SAP BusinessObjects Planning and Consolidation. select Retrieve from the menu. check the box next to the EPM connection you have created. Do not check the Refresh On Load option of the Connection Refresh button because unexpected data might be saved. so that the data will be sent when clicking the Refresh button. Use the components that you think are the most appropriate to the final Flash object. click the Link to Cell cell selector button and select the first cell of the data grid. In the Properties panel on the right. "Refresh" appears by default.Using Dashboard Design components Note: In this section. so that any error messages will be displayed. Step 2 . select Bind from the menu. Note: • • • All the data is saved to the server. • Input Text.Flash Objects • • • You can retrieve the data that exists on the server for the specified members. You can create a connection in order to retrieve the Business Process Flows. In the Result area of the Output section. see Creating a Connection in Dashboard Design. Tip: Apply a color to the selected cells so that you can easily identify them. • Connection Refresh Button. you can also select a cell using the cell selector button in the Message area. click the Data cell selector button to select the cells in the spreadsheet that will contain the page axis dimensions. version for the Microsoft platform. You can reference another cell from which the data will be taken. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. 192 2013-09-04 . In the Label area. the recommended components are only suggestions. It will then be saved to the server. Once you have configured the operation type. Select one cell. In the Properties panel on the right. Step 1. Once you have configured the operation type. check the box next to the EPM connection you have created. see Creating a Connection in Dashboard Design. use the cell selector button to select a destination cell range.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. Step 1. so that any error messages will be displayed. Select the Retrieve Context operation. 25. so that the connection is refreshed when clicking the Refresh button. Select the data source. then the model. 193 2013-09-04 . Tip: You can bind the context area with the cells resulting from the Retrieve Context operation. Tip: Apply a color to the selected cells so that you can easily identify them. In the Result area of the Output section.Using Dashboard Design components Note: In this section. version for SAP NetWeaver. Use the components that you think are the most appropriate to the final Flash object. It is recommended that you select as many columns as the number of details checked. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. you can also select a cell using the cell selector button in the Message area. the recommended components are only suggestions. then the environment. You can create a connection to retrieve the web context members for a specific model. version for the Microsoft platform and SAP BusinessObjects Planning and Consolidation.10 Retrieve Context Applies to: SAP BusinessObjects Planning and Consolidation. In the Properties panel on the right.1. If needed. click the Data cell selector button to select the cells in the spreadsheet that will contain the Business Process Flows. Select the Business Process Flow properties you want to display by checking the boxes in the Details area. • Connection Refresh Button. then the BPF model and the context for which you want to retrieve the business process flows. and a large number of rows so that all the Business Process Flows will be displayed . Step 2 .Flash Objects Select the Retrieve Business Process Flows operation. In the Properties panel on the right. then the model for which you want to retrieve the context members. you can only display Unicode type text (UTF-8). In the Properties panel on the right. Tip: Apply a color to the selected cells so that you can easily identify them. version for SAP NetWeaver. Once you have configured the operation type.Using Dashboard Design components Note: In this section. so that the connection is refreshed when clicking the Refresh button. so that all the members will be retrieved. In the Properties panel on the right. see Creating a Connection in Dashboard Design. In the Result area of the Output section. Use the components that you think are the most appropriate to the final Flash object. For SAP BusinessObjects Planning and Consolidation. then the environment.Flash Objects Select the data source. Step 2 . you can also select a cell using the cell selector button in the Message area.1. use the cell selector button to select a destination cell range. The members that are retrieved are the members defined as default members.txt extension. • Input Text Area (if you have selected a cell for messages to be displayed). so that any error messages will be displayed. Note: • • The file must have the . If needed.11 Retrieve Text from Documents View Applies to: SAP BusinessObjects Planning and Consolidation. You can create a connection to retrieve the text contained in a file stored in the Documents view.Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. click the Link to Cell cell selector button to select the cell in the spreadsheet that will contain the error message text. the member name. check the box next to the EPM connection you have created. version for SAP NetWeaver. 25. Step 1. the member unique ID) and a large number of rows. version for the Microsoft platform and SAP BusinessObjects Planning and Consolidation. In the Properties panel on the right. • Connection Refresh Button. 194 2013-09-04 . the recommended components are only suggestions. It is recommended that you select three columns (for the dimension name. click the Data cell selector button to select the cells in the spreadsheet that will contain the context members. it is recommended that you place the appropriate components in the canvas area as follows: • Grid. then the environment. In the Properties panel on the right. Use the components that you think are the most appropriate to the final Flash object. Step 2 . then the environment. Select the data source. If needed. then the model for which you want to retrieve property values. Select the data source. then the model for which you want to retrieve text. Tip: Apply a color to the selected cells so that you can easily identify them. it is recommended that you place the appropriate component in the canvas area as follows: • Input Text Area. Click in the File area: the list of files for the model is displayed. In the Properties panel on the right.1. you can also select a cell using the cell selector button in the Message area. Creating the connection To create the connection using the Dashboard Design Data Manager dialog box. Select the Retrieve Members Property Values operation. the recommended components are only suggestions. use the cell selector button to select a destination cell range. In the Result area of the Output section. you want to retrieve the members that are calculated and the members for which you can enter data.12 Retrieve Members Property Values Applies to: SAP BusinessObjects Planning and Consolidation. using the CALC property.Using Dashboard Design components Note: In this section. version for the Microsoft platform and SAP BusinessObjects Planning and Consolidation. Once you have configured the operation type. so that any error messages will be displayed. 25.Flash Objects Select the Retrieve Text From Documents View operation. click the Link to Cell cell selector button to select the cell in the spreadsheet that will contain the text of the selected file. 195 2013-09-04 . You can create a connection to retrieve the values of a specific property for the members of a specific dimension. Select one cell. • Connection Refresh Button. so that the connection is refreshed when clicking the Refresh button. Select a file. check the box next to the EPM connection you have created. version for SAP NetWeaver. see Creating a Connection in Dashboard Design. For example. you can also select a cell using the cell selector button in the Message area. you can perform the following actions: • Insert a Flash object. An inserted Flash object takes into account the active connection and the context dimensions.2 Flash Object Insertion You can insert a Flash object in a report. Related Topics • Flash Object Creation. the Flash object is updated accordingly in the report. display the Developer tab and activate the Design Mode in Microsoft Office Excel or Microsoft Office Word (the design mode is native in Microsoft Office PowerPoint). • Remove the selected Flash object from the sheet by clicking Remove. the member name. In the list of members. double-click on a member: the member is displayed in the bottom part of the window. a property and one or more members for the selected dimension. • Remove all the Flash objects from the sheet by clicking Remove all. use the cell selector button to select a destination cell range. It is recommended that you select three columns (for the member unique ID. 25. To do so. To manage Flash objects. • Rename the Flash object by pressing F2. data ranking and data filtering. click in the Members area. the property value). In the Result area of the Output section. double-click on the member in the bottom part of the window. You can move or resize the Flash object as needed. If you want to remove a member from the selection. if you change a dimension member in the context. For example. If needed. so that any error messages will be displayed. using EPM Connector 196 2013-09-04 . Tip: Apply a color to the selected cells so that you can easily identify them. You can move a Flash object in the report and resize it to make it bigger or smaller. To select members. In the Flash Object Manager.Flash Objects Select a dimension. select EPM > More > Flash Objects. Click Add and select the Flash object you want to insert in your report. You can also enter a name for the object. data sorting. The report in which you have created the Flash object and the report in which you want to insert the Flash object should have a similar structure. and as many rows as the number of members you have selected. Note: The following functions are not supported: nested dimensions in a row or column axis. A chart automatically reflects the changes in the report's data range. Note: • • When adding a blank row or column. select the Refresh Charts Automatically in Options > User Options. such as expand or collapse. the Legend entries (Series) of the chart are not automatically refreshed. To dynamically refresh the charts when performing actions in the report. 197 2013-09-04 .Dynamic Charts Dynamic Charts Microsoft Office Excel enables you to insert charts. Only two-axis charts are automatically refreshed. Dynamic Charts 198 2013-09-04 . size) for levels of a hierarchy. all the format settings are applied and • • 199 2013-09-04 . Checkboxes enable you to specify the formatting sections (for example: Hierarchy Level Formatting section) or formatting items inside a section (for example: Base Level Format) that you want to apply to the reports.Dynamic Formatting Dynamic Formatting You can define specific dynamic formatting in a template to apply to sheets or reports. • Common actions to several formatting sections • Checkboxes. On each template. you can copy or move the sheet to another Microsoft Office Excel workbook. Dynamic formatting is defined in dedicated sheets. Inside each section. When you click the Priority to Column option. A default template is provided with the add-in. the format settings are applied from the lowest area to the upper area. You can create additional template sheets by copying the default sheet as you would copy a standard Microsoft Office Excel worksheet. These options enable you to specify which one of the defined formats for rows or columns will be applied first in case of conflicts. types of members. types of members. the Column section is displayed first in the formatting section and the Row section is displayed in second position in the formatting section and the precedence rules apply. Tip: As a dynamic formatting sheet is a standard Microsoft Office Excel sheet. you can define a specific format (for example: font. the format settings in lower sections override the ones in upper sections in case of conflicts (for example: inconsistency between a member format and a level format). You can define the format you want by using the standard Microsoft Office Excel cell formatting features in the 1000 and Label cells. A specific format (such as font.1 Dynamic Formatting Template Definition Dynamic formatting is defined in a dedicated sheet. color. 27. or size) can be defined for levels of a hierarchy. Precedence rules • If you check more than one formatting section. Formatting. color. if you check several Apply checkboxes. By default. Priority to column or row format. odd/even rows or columns and page axis dimensions. odd/even rows or columns and page axis dimensions. click Add New Level. using a specific syntax . You can then specify which settings of the defined format you want to apply. the outer dimension being the first dimension in the axis. leave the Use cell blank. Note: In this particular section.for example: (FontBold = Y) | (FontSize = 18). such as the Calculated Member Default Format section. you can define format settings for the levels that are displayed in the reports. locking cells will have no effect until you protect the worksheet. enter the format and click Override. the frame setting may not be properly applied to the rows or colums that are displayed consequent to a member expansion or a member insertion. You want to lock the cells for the other types of members. but it is the first level that is displayed in a report. You can define formatting on specific levels. Country is the second level of the geographical hierarchy in the structure. meaning members that are not nodes and not calculated.Dynamic Formatting ALL is displayed in the Use column. Level 1. In the Default Format area. use EPM > Lock Selected Cells in the other member sections of the EPM dynamic formatting sheet. Then. Hierarchy Level Formatting section This section enables you to define the formatting of levels of hierarchies. protect the worksheet. directly enter the format settings in a Use cell. all the format items that you can override are displayed in red. Therefore. Since the cells are unlocked by default in the EPM dynamic formatting sheet. Select one of them. Example: You want to be able to enter data only in the inputable member cells and not in the other member cells of a report. • • • 200 2013-09-04 . • • By default. see Worksheet Protection. right-click one or more cells and select EPM > Lock Selected Cells or EPM > Unlock Selected Cells. In the dialog box. you can define a specific format for base level members. To do so. Level 2 and so on are the hierarchy levels just like they are defined in the structure of the source connection. see Expand or Member Entry Using the Insert Members Dialog Box. To apply no formatting. then Default Format. you can define a default format for hierarchy levels. To do so. the precedence rule is as follows: Base Level Format. use the Relative Levels option. click Remove Last Level. you can specify to which dimension you want the defined format to be applied. Actions specific to the Hierarchy Level Formatting section: • Apply Format to option: If a row or column axis contains more than one dimension. you do not need to unlock the inputable member cells. To remove a level. To do so. To add a new level. or double-click a Use cell and define the format settings in the dialog box that opens. then Formatting on Specific Level. or double-click the Use cell and select None in the dialog box. As a reminder of the standard Microsoft Excel behavior. click the Override Selected Item option. For example. the inner dimension being the last dimension. In the Base Level Format area. or define additional settings. • Cell Protection: you can lock and unlock cells on which you define formats. Note: If you have specified the Frame setting and if you have selected the Refresh only Expanded and Inserted Members option in the User Options. You will be able to enter data only in the inputable member cells. For more information on how to protect a worksheet. The corresponding option is Structure Levels. For more information about this option. However. Dynamic Formatting Note: When you select the Relative Levels option. properties. For more information on this option. see Expand or Member Entry Using the Insert Members Dialog Box. the Start formatting from the lowest level displayed option is displayed. the name you must enter is the name of the local member as it appears in the Local Members tab of the Report Editor. A changed member is an inputable member on which you have already entered data but have not yet saved. You can select the context member of a specific dimension as the property value in the Property Selection tab. right-click in the tab and select Remove Selected Item(s). • Tip: To remove an item from the selection in the Multiple Selection Overview tab. Dimension Member/Property Formatting section This section enables you to define and apply the formatting defined to the following types of members: • Custom members. when using a Planning and Consolidation connection. If you click OK in one of the three other tabs. Caution: • To validate your multiple selection. the Add to Multiple Selection button enables you to add a member. custom member. calculated members. property or local member: To do so. 201 2013-09-04 . If you have selected the Refresh only Expanded and Inserted Members option in the User Options. Note: • In the Local/Blank Member Selection tab. You can also define specific formatting: • on a specific member. Note: An inputable member is a member on which you can enter data. then click the Local/Blank Member Selection tab and select Blank Members. local members. a property or a local member (depending on the tab you are in) to the multiple selection. click the Add Member/Property cell and make your selection in the Select Member/Property dialog box. blank member. the multiple selection is not taken into account. as you have named it in the Member Sorting & Grouping area of the Member Selector. click the Add Member/Property cell. This option enables you to invert the level order. on a multiple item selection. • • • on blank members: To do so. The item is automatically added to the Multiple Selection Overview tab. for a grouping local member. blank members when using any connection. not all the settings may be applied to the multiple selection. • Inputable members and changed members. In the first three tabs. local members. To do so. that is a combination of any of these items: members. the lowest level is displayed in first position. you must select the Multiple Selection Overview tab and click OK. or. click the Add Member/Property cell and make your selection in the Select Member/Property dialog box. In the Member Selection tab. select 2010 Total and click Add to Multiple Selection. displaying: Actual||2010 Total. the formatting settings may not be properly applied to the rows or colums that are displayed consequently to a member expansion or a member insertion. Related Topics • Dynamic Formatting Template Definition 202 2013-09-04 . and if you have selected the Refresh only Expanded and Inserted Members option in the User Options. Click the Add Member/Property. For more information on this option.Dynamic Formatting Note: multiple item selection including a local member: if the local member specified in the formatting sheet row does not exist in the report definition. the formatting is applied. The chosen format in Odd Formatting and Even Formatting will alternate in rows or columns. Note: If you have defined formatting settings only for the odd rows/columns or only for the even rows/columns. A new row is added to the formatting sheet. If the local member exists in the report definition but is disabled.1 Defining a Dynamic Formatting Template 1. Define the format you want for the data. The sheet is named EPMFormattingSheet. Define the format you want. using the Add Dimension button. 27. 2. Row and Column Banding section This section enables you to choose one or two alternating formats that will be applied to data or headers or both. select Actual and click Add to Multiple Selection.1. click on the Remove cell. To remove a member or property from the formatting sheet. Select the Multiple Selection Overview tab and click OK. Page Axis Formatting section This section enables you to define the formatting for all the dimensions of the page axis. the formatting defined in the row is simply not applied. The dynamic formatting sheet appears. Example: You want to define a specific format for any data at the intersection of Actual and 2010 Total. Then. Select EPM > View Formats. You can also define formatting settings on specific dimensions that are part of the page axis. see Expand or Member Entry Using the Insert Members Dialog Box. you can decide whether to keep the existing formatting and override it with the dynamic formatting. you must refresh the report to which you applied the dynamic formatting. Click OK.2. the selected template applies to all reports in the worksheet. The chosen dynamic formatting template applies by default to all the reports created in the worksheet. If you modify a dynamic format which has already been applied to a specific worksheet. Select the template you want to apply to the worksheet from the Default Formatting Sheet list.Dynamic Formatting 27. If a default template has been selected for the worksheet. If a sheet contains several reports. SelectEPM > Options > Sheet Options. select the Clear report format before applying dynamic formatting option. 27. already contain formatting applied by an add-in other than the EPM add-in. you can however choose another template to apply to a specific report. 6. • To clear the existing format so that only the EPM dynamic formatting is applied. Select the Apply Dynamic Formatting option. • a specific report. refresh the report. By default. 2. The Sheet Options dialog box opens. 4. 27. or to clear the existing format and only apply the dynamic formatting.2 Applying a Default Dynamic Formatting Template to a report 203 2013-09-04 .2. If the reports to which you want to apply dynamic formatting. deselect the Clear report format before applying dynamic formatting option. already contain formatting applied by an add-in other than the EPM add-in.1 Applying a Default Dynamic Formatting Template to the Worksheet 1. To display the formatting on your report.2 Dynamic Formatting Applied to a Worksheet or to a Specific Report You can apply a dynamic formatting template to: • the current worksheet. do one of the following: • To keep the existing formatting and override it with the dynamic formatting. 3. If the reports to which you want to apply dynamic formatting. 5. you can apply a dynamic formatting template by report. Select the Formatting tab. SelectEPM > Edit Report. Click OK. Select the Options tab. select the Clear report format before applying dynamic formatting option. Select a cell in the report to which you want to apply a dynamic formatting template. Select the template you want to apply. already contains formatting applied by an add-in other than the EPM add-in. 6. deselect the Clear report format before applying dynamic formatting option. 5. If the report to which you want to apply dynamic formatting. The Report Editor opens. 3.Dynamic Formatting 1. then the Apply Dynamic Formatting option is already checked. 2. If a default dynamic formatting template has been selected for the whole workbook in the Sheet Options. do one of the following actions: • To keep the existing formatting and override it with the dynamic formatting. • To clear the existing format so that only the EPM dynamic formatting is applied. 204 2013-09-04 . 4. For more information about the context lock. leave the context members selected by default. but with different dimension members: the members you have selected. and it saves you from having to create several reports for different dimension members. Create a report. In the dialog box that opens. Example: Creating as many reports as quarters: For the year 2009. follow these steps: 1. If needed. 4. SelectEPM > Report Actions > Worksheet Generation. Note: Each sheet is automatically named with the dimension member combinations. select the Period dimension. Each time you select an additional member. depending on the Remove EPM Worksheets Before Generation user option (Options > User Options > Others): • If the Remove EPM Worksheets Before Generation option is selected: 205 2013-09-04 . The Worksheet Generation dialog box opens. Each one contains the same report. except for the period members. For each dimension of the report. and so on. To automatically generate several sheets in the current workbook. You can then unlock the dimension. The dimensions for which you have selected members are automatically locked in the context bar on each worksheet. see Context. Create a report that meets your needs. do not select other members. SelectEPM > Report Actions > Worksheet Generation. based on an existing report. then select the four quarters and click OK. This feature helps you to quickly create several worksheets inside a single workbook. The resulting workbook can contain different worksheets. The first sheet contains the report displaying data for quarter 1 of 2009. Note: The number of selected members for all dimensions is displayed. you want to create one sheet per quarter. Four sheets are automatically created in the current workbook. 2. based on a specific report but including variable dimension members.Workbook Sheet Automatic Generation Workbook Sheet Automatic Generation You can automatically generate several reports in several sheets within the current workbook. then click Select Members and select the members you want for the dimension. Each automatically created sheet displays the initial report. Select the dimension. the number is updated. the second sheet contains the report displaying data for quarter 2 of 2009. repeat the selection for the other dimensions. 3. 206 2013-09-04 . including the current worksheet.Workbook Sheet Automatic Generation • • • The workbook will contain the worksheets resulting from the generation. the workbook will contain all the worksheets existing in the workbook before you launch the generation and all the worksheets resulting from the generation. If the Remove EPM Worksheets Before Generation option is not selected. the dynamic formatting sheet (if any) and any other Microsoft Excel sheets (if any). The workbook will not contain any of the EPM worksheets existing in the workbook before you launch the generation. see Worksheet Protection. moved or deleted. This is to prevent important elements of the reports from being changed. When switching back to online mode. even users who do not have the EPM add-in installed. The context bar and the pane are automatically hidden. • By default. select EPM > Offline Mode. Note: The offline feature is used in an automatic way when distributing reports. select the Do not Protect Workbook option in the Others tab of the User Options before switching to offline mode. The reports can be modified by using standard Microsoft Excel features. the worksheets of an offline workbook are automatically protected. All the EPM member formulas are converted into text. For more information about worksheet protection. To switch to offline mode. An offline workbook behaves like a standard Microsoft Office Excel workbook. Related Topics • Workbook Distribution 207 2013-09-04 . the modifications are not kept and the initial reports are displayed. You can make your workbook available to any user. • If you do not want the worksheets to be protected.Offline Mode Offline Mode You can make the current workbook an offline workbook so that any user can access it. Offline Mode 208 2013-09-04 . select EPM > Options > Sheet Options. To unprotect a worksheet or worbook. This option is selected by default. You can unprotect a sheet using the Microsoft Excel feature or the EPM add-in feature. You can also protect certain elements of the current worksheet or workbook. the workbook or only certain elements. Note: The Microsoft Excel sheet protection always overrides the EPM add-in sheet protection. see Context. and to enter a password. see the Microsoft Excel documentation. moving. Tip: Choose a password that is easy to remember. with a password. However. A message appears in which you can enter the protection password. For more information about offline mode. see Offline Mode. If you protect a worksheet containing reports in which a user will enter data. or deleting important elements of the report. you must use the EPM add-in feature. For more information on context options. • To protect the sheet. Use the option Edit Context Options. For more information. You can specify if you want to be able to edit the context options using the Context Options dialog box. Note: When you make a workbook an offline workbook. For more information on how to insert members. because if you lose the password. to protect a sheet. you can protect the current worksheet or the whole workbook. Note: For details about the other elements you can protect. see Member Entry Using the Insert Members Dialog Box. you may be able to insert certain members in the report. you can no longer access the protected worksheet or workbook. its worksheets are automatically protected. select No Protection. see Dynamic Formatting Template Definition. 209 2013-09-04 .Worksheet Protection Worksheet Protection To prevent a user from changing. Note: • Even if a worksheet or workbook is protected. you can lock certain and unlock other cells of the report. when a worksheet is protected. In the Protection tab of the Sheet Options. then select the Protection tab. select EPM > Options > Sheet Options. provided that member insertion filters have been defined. Worksheet Protection 210 2013-09-04 . • The SAP BusinessObjects Planning and Consolidation Documents view. Publish Reports to BI launch pad Applies to: SAP BusinessObjects Enterprise connections. To publish a workbook containing reports. Note: You cannot publish reports on the BI launch pad: • If you are using the EPM add-in in standalone mode. which is the web portal of SAP BusinessObjects Enterprise. At one time. you can make all the workbooks containing reports available to users by sending all the workbooks by email or by storing the workbooks at a specific location that users can access. 31. You can schedule the publication. select EPM > Portal Publication > Publish to BI launch pad. For more information about rights. At one time. you can export all the books to PDF format or print them. • The SAP BusinessObjects Planning and Consolidation Documents view.Collaboration Collaboration There are different ways to make the reports available to other users: • You can publish all the reports as they are on two web portals: • The BI launch pad. You can distribute automatically generated reports based on a selection of variable members. • If you do not have the Publish right set in the Central Management Console for the EPM connection manager. which is the web portal of SAP BusinessObjects Enterprise. 211 2013-09-04 . • • You can publish automatically generated books based on a selection of variable members. The four buttons on the left part of the dialog box enable you to perform the following actions: • Refresh the BI launch pad folder tree. The published reports will be available on the BI launch pad to users who have the necessary access rights. You can schedule the distribution. The dialog box that opens displays the folders that exist in the BI launch pad. see the SAP BusinessObjects Financial Consolidation Security Guide.1 Report Publication to a Web Portal You can publish all the reports of a workbook on two web portals: • The BI launch pad. For more information. the connection on which publication and distribution actions are performed is the connection that is currently displayed in the Active Connection of the EPM pane.2. displaying the Documents view.1 Book Publication Using a template. You can search for a specific folder by selecting a search criteria from the dropdown list and by clicking the Search button. You can then publish a report by using the web client dedicated features. selectEPM > Portal Publication > Open Planning and Consolidation Documents View. Delete a folder from the BI launch pad. The Planning and Consolidation web client opens.2 Publication and Distribution Connection Both publication and distribution are performed on one specific connection. you can generate books (meaning static reports). see the SAP BusinessObjects Planning and Consolidation Help. The description appears along with the workbook in the BI launch pad.Collaboration • • • Create a new folder in the BI launch pad. By default. All the comments are historized. • Or select the connection from the Active Connection dropdown list of the EPM pane. 31. If you want to perform publication and distribution actions on a different connection than the active connection. The Description field enables you to enter a description for the workbook. 31. then select the connection in the Change Connection dialog box. To publish a workbook containing reports. based on: 212 2013-09-04 . you can add your comments on each workbook in the dedicated Discussions area. Note: The connection selected from the Active Connection dropdown list is automatically taken into account in the Change Connection dialog box. choose one of the following actions: • Select EPM > Book Publication > Change Connection or EPM > Distribution > Change Connection. Note: In the BI launch pad. Rename an existing folder in the BI launch pad. Publish reports to Planning and Consolidation Documents View Applies to: Planning and Consolidation connections. Collaboration • • one or more reports, one or more variable members for one or more dimensions. Each automatically created book displays the initial report(s), but with a different dimension member (or a combination of dimension members) of the dimension(s) for which variable dimension members have been defined. At one time, you can export all the generated books to PDF format, or you can print them. You can launch the book publication or you can schedule it (for example, every Friday at 11:00 PM). 31.2.1.1 Book Publication Template Before launching a book publication, you must create a book publication template in which you specify the information you want to include in the books, including specific settings on dimension members. Note: Choose carefully the names you enter for the publication template, the sections and the report workbook descriptions, as they will appear as the names of the folders if you then choose to generate the books in PDF format. Take into account the following: • You should not use the following characters as they are changed into the _ character in the folders and book names: \ / : * ? " < > | & + = ( ) { } [ ] $ % • You should not enter a space at the beginning or the end of the names. • A section name and a workbook description must be unique within a template. Otherwise, you cannot save the template. Book Publication Template for a Local or SAP BusinessObjets Enterprise Connection Creating or modifying a template consists of the following steps: • Enter a name for the template. • Section definition. A template can include one or more sections. A section is a part of the template. Each section includes at least a selection of variable dimension members. When launching the report generation, you will be able to select the sections of the template you want to take into account. Note: The tab of a section has no name until you enter it in the Section Name area. • • Enter a name for the section. The entered name is displayed on the section tab. Report workbook selection. Select the workbook containing the reports you want to generate using the current template. Note: The workbooks you select must contain reports that have the same connection as the template. • • Enter a description for the workbook you have selected. Dimension member selection: • One or more dimensions for which one or several members are variables. For a specific dimension, the members selected as variables will override the members if the dimension is 213 2013-09-04 Collaboration • displayed in the page axis or in the context of the report. One report is created for each member selected. One or more dimensions for which only one member is fixed. This is optional. A fixed member overrides any other member of the same dimension that is part of the report in the context or the page axis. For example, if you select the period 2009 as a fixed member and the period 2008 is displayed in the page axis of the report, 2009 will be taken into account. Note: • • A suppressed member behaves exactly like a fixed member, but this feature remains for historical reasons. You cannot select fixed, suppressed and variable members for one dimension. All of them are mutually exclusive. In the published reports, the members will be displayed according to the following precedence rule: 1. members in the row and column axes. 2. members selected as fixed members or as variable members in the publication template. 3. members in the page axis. 4. members in the context. Note: The template is saved as an .xlt or .xltx file, by default to the following local folder: C:\Documents and Settings\[UserWindows]\My Documents\PC_LOC\ [login]\books\[appset]\[application]\[team or localTeam]\WebExcel\ManageBook Other actions available on a template include: • You can open an existing template, modify it and save it with a different name by selectingEPM > Book Publication > Open Template. Note: If a report workbook specified in the template does not contain valid reports, the template opens but the report workbook area is empty. If you want to save your template, you need to specify another workbook that contains valid reports. • You can create a new section or a section based on an existing one. You can also delete a section from the template. These actions are available in the template dialog box, under the section tab. Book Publication Template for a Planning and Consolidation connection Creating or modifying a template consists of the following steps: • Enter a name for the template. • When modifying a template, if you intend to generate the reports in PDF format, you can select an option in the Add/Replace dropdown list. These options enable you to replace or add sections to a template based on the selected variable members. You can choose: • Add, to add new books (with different member combinations) to the current template. This means that new PDFs are created and the former ones remain. This option applies to all the sections of the template. 214 2013-09-04 Collaboration • Replace, to replace books of the existing template with new books. This means that if a specified member combination is found, it overwrites the existing section. Therefore, the existing PDF files with the initial variable member selection are deleted on the server and replaced by the ones generated from the latest variable member selection. This option applies to all the sections of the template. Note: When you create a new template, you must select Replace. • • Specify by Section. Select this option if you want to specify the Add or Replace settings by section, and not for the whole template. • The Variable Time field is displayed. If no member is selected for the Time dimension in a section of the template as a variable or fixed member, the time member selected here applies to all the sections of the template and is hard-coded. If you select a Time member in a section, it overrides the member selected in the Variable Time field for this section. Section definition. A template can include one or several sections. A section is a part of the template. Each section includes at least a selection of variable dimension members. When launching the report generation, you will be able to select the sections of the template you want to take into account. Note: The tab of a section has no name until you enter it in the Section Name area. • Enter a name for the section. The entered name is displayed on the section tab. Note: If you have selected the Specify by Section option in the Add/Replace dropdown list at the template level, select the setting you want to apply to the current section. • Report workbook selection. Select the workbook containing the reports you want to generate using the current template. Note: The workbooks you select must contain reports that have the same connection as the template. • • Enter a description for the workbook you have selected. Dimension member selection: • One or more dimensions for which one or several members are variables. For a specific dimension, the members selected as variables will override the members if the dimension is displayed in the page axis or in the context of the report. One report is created for each member selected. • One or more dimensions for which only one member is fixed. This is optional. A fixed member overrides any other member of the same dimension that is part of the report in the context or the page axis. For example, if you select the period 2009 as a fixed member and the period 2008 is displayed in the page axis of the report, 2009 will be taken into account. Note: • • A suppressed member behaves exactly like a fixed member, but this feature remains for historical reasons. You cannot select fixed, suppressed and variable members for one dimension. All of them are mutually exclusive. 215 2013-09-04 Collaboration In the published reports, the members are displayed according to the following precedence rule: 1. members in the row and column axes. 2. members selected as fixed members or as variable members in the publication template. 3. members in the page axis. 4. members in the context. Note: The template is saved as an .xlt or xltx file. Other actions available on a template include: • You can open an existing template, modify it and save it with a different name by selectingEPM > Book Publication > Open Template. Note: • If a report workbook specified in the template does not contain valid reports, the template opens but the report workbook area is empty. If you want to save your template, you need to specify another workbook that contains valid reports. The Save the template in a different location is available and enables you to choose another location on the server to save the template. • • • You can create a new section or a section based on an existing one. You can also delete a section from the template. These actions are available in the template dialog box, under the section tab. If you have opened a Plannning and Consolidation publication template using the EPM > Open > Open Server Root Folder, meaning without using the dialog box dedicated to the publication template, you can then use the Save, Save as and Validate commands available inEPM > Book Publication. See Open Actions. 31.2.1.1.1 Creating Publication Templates for a Local or SAP BusinessObjects Enterprise Connection Note: • • You must be granted the right to create a book publication template or you will not be able to save the template. A template is created by default on the first connection used in the workbook. If you want to create a template on a different connection, selectEPM > Book Publication > Change Connection. A template can only apply to reports using the same connection. Choose carefully the names you enter for the publication template, the sections and the report workbook description, as they will appear as the names of the folders if you publish the reports in PDF format. • • • You should not use the following characters, as they are changed into the _ character in the folders and book names: \ / : * ? " < > | & + = ( ) { } [ ] $ % You should not enter a space at the beginning or the end of the names. A section name and a workbook description must be unique within a template. If not, you cannot save the template. • 216 2013-09-04 Collaboration 1. Select EPM > Book Publication > New Template. The Book Publication Template dialog box opens. 2. Enter a name for the template. 3. Enter a name for the section. The entered name is displayed on the tab of the section. 4. Select a workbook that contains the reports you want to publish and enter a description for the report workbook. Note: • • The workbook you select must contain reports that use the same connection as the template. When clicking the arrow next to the ellipsis button, the Local Browser is selected by default. 5. You can select other workbooks and enter a description for them by clicking the green cross icon. 6. Click Select Dimensions. The Dimension Selector opens. 7. Select the checkbox for a dimension and click the Add button of the area you want. You must add at least one dimension in the Variable Members area. The selection of dimensions for the fixed and the suppressed members is optional. 8. Click OK. 9. For each dimension selected, click the button next to it and select the members you want in the Member Selector. You can only select one member per dimension as a fixed or suppressed member. Note: Once a dimension has been selected, you can select an additional member by clicking the green cross icon. 10. You can create one or several sections by clicking the Add New Section button and repeating steps 3 to 9. 11. Click Save. Note: If the Save button is disabled: check that you have performed all the above steps; check also that the names of the sections and the workbook descriptions you have entered are unique within the template; and check that you are granted the right for creating a book publication template. 12. In the Save As dialog box, select a format (.xlt or .xltx) and enter a name for the template file. The template is saved to the following local folder: C:\Documents and Settings\[UserWindows]\My Documents\PC_LOC\ [login]\books\[appset]\[application]\[team or localTeam]\WebExcel\ManageBook. 31.2.1.1.2 Creating Publication Templates for a Planning and Consolidation connection Note: • You must be granted the right to create a book publication template or you will not be able to save the template. 217 2013-09-04 Collaboration • • A template is created by default on the first connection used in the workbook. If you want to create a template on a different connection, select EPM > Book Publication > Change Connection. A template can only apply to reports using the same connection. Choose carefully the names you enter for the publication template, the sections and the report workbook description, as they will appear as the names of the folders if you publish the reports in PDF format. • • • You should not use the following characters, as they are changed into the _ character in the folders and book names: \ / : * ? " < > | & + = ( ) { } [ ] $ % You should not enter a space at the beginning or the end of the names. A section name and a workbook description must be unique within a template. Otherwise, you cannot save the template. 1. Select EPM > Book Publication > New Template. The Book Publication Template dialog box opens. 2. Enter a name for the template. 3. If you intend to publish the books in PDF format, select an option in the Add/Replace dropdown list. 4. You can select a member of the Time dimension using the Variable Time field. 5. Enter a name for the section. The entered name is displayed on the tab of the section. 6. If you have selected Specify by Section in the Add/Replace dropdown list at the template level, select Add or Replace for the current section. 7. Select a workbook that contains the reports you want to publish and enter a description for the report workbook. Note: • • The workbook you select must contain reports that use the same connection as the template. When clicking the arrow next to the ellipsis button, the Server Browser is selected by default. 8. You can select other workbooks and enter a description for them by clicking the green cross icon. 9. Click Select Dimensions. The Dimension Selector opens. 10. Select the checkbox for a dimension and click the Add button of the area you want. You must add at least one dimension in the Variable Members area. The selection of dimensions for the fixed and the suppressed members is optional. 11. Click OK. 12. For each dimension selected, click the button next to it and select the members you want in the Member Selector. You can only select one member per dimension as a fixed or suppressed member. Note: Once a dimension has been selected, you can select an additional member by clicking the green cross icon. 13. You can create one or several sections by clicking the Add New Section button and repeating steps 5 to 12. 218 2013-09-04 Collaboration 14. Click Save. Note: If the Save button is disabled: check that you have performed all the above steps; check also that the names of the sections and the workbook descriptions you have entered are unique within the template; and check that you are granted the right for creating a book publication template. The Save dialog box opens. 15. Select a format (.xlt or .xltx) and enter a name for the template file. 31.2.1.2 Book Publishing Once you have created a template, you can publish the books right away or schedule the publication, as books to print, as PDF files or Microsoft Excel files. Book Publication Scheduling • • The schedules you create are automatically saved for the current connection in the Microsoft Windows Scheduled Tasks. As you use Microsoft Windows Scheduled Tasks to schedule a book publication, you need to be administrator of your machine. If you are not (for security reasons), you can still use Windows Scheduled Tasks if you are granted certain Windows rights. For more information, see http://sup port.microsoft.com/kb/883273/en-us. Book Printing If you choose to print the books, you can use the following options: • Print one sheet for all dimensions members combination. This option enables you to define the printing order. This option is not checked by default. For example, a workbook contains two sheets and the variable members that you have selected in the template are: Spain, Italy. • If you select this option, the printing is performed in the following order: 'Sheet 1 - Spain', 'Sheet 1 - Italy', 'Sheet 2 - Spain', 'Sheet 2 - Italy'. • If you do not select this option, the printing is performed in the following order: 'Sheet 1 - Spain', 'Sheet 2 - Spain', 'Sheet 1 - Italy', 'Sheet 2 - Italy'. • Print sheets with no data. This option enables you to specify that a sheet be printed even if none of the books in the sheet contain any data. This option is not checked by default. Book in PDF Format If you export the books in PDF format, note that by default, one PDF file is generated by combination of variable members. If you want to generate all the books in one single PDF, select the Single PDF option. The books in PDF format are stored at the following location, depending on the connection you use: 219 2013-09-04 Collaboration • • If you use a Local or an SAP BusinessObjects Enterprise connection, the books are stored at the following local location: C:\Documents and Settings\[UserWindows]\Local Settings\Temp\_PATH_PUBLISH If you use a Planning and Consolidation connection, the books are stored on the server. You can then view the books from the Planning and Consolidation web client. For more information, see the SAP BusinessObjects Planning and Consolidation Help. Book in Microsoft Excel Workbook You can publish the books in one single Microsoft Excel workbook. The workbook is stored locally, in the folder you specify. 31.2.1.2.1 Launching Book Publication Before launching a publication, you must have defined a publication template. 1. SelectEPM > Book Publication > Publish Books. The Book Publication Wizard opens. 2. Select Publish Now and click Next. 3. To print the books: a. Select Printer. b. Enter the printer path or select it, using the ellipsis button. c. Depending on the printing order you want, you can select the Print one sheet for all dimensions members combination option. d. To specify that a sheet be printed even if none of the reports in the sheet contain any data, select the Print sheets with no data option. 4. To generate the books in PDF format: a. Select Publish to PDF Format. b. By default, one PDF file by combination of variable members is generated. If you want to generate all the reports in one single PDF, select the Single PDF option. c. If you are using a Planning and Consolidation connection and you have not selected Single PDF, select the location where the template you want use is stored (Public or a specific team). d. If you are using a Planning and Consolidation connection and you have selected Single PDF, specify if the PDF files should be accessible only to you (select Private), to all the users (select Public) or to a specific team (select Team and select the team from the dropdown list). 5. To generate the books in a Microsoft Excel workbook: a. Select Publish to single Microsoft Excel workbook. b. Enter a name for the workbook and select a local folder. 6. Select the templates, then the template sections you want to use to generate the books. When using a Planning and Consolidation connection, you can select a team so that all the templates for the selected team are displayed. You can then select the template and sections you want. A summary displays information about the books to be generated. 7. Click Next. The report generation is launched and the process steps are displayed. 220 2013-09-04 Collaboration When using a Local or an SAP BusinessObject Enterprise connection, the books in PDF format are stored by default at the following local location: C:\Documents and Settings\[UserWindows]\Local Settings\Temp\_PATH_PUBLISH. 31.2.1.2.2 Scheduling Book Publication • • Before launching a publication, you must have defined a publication template. Since you use Microsoft Windows Scheduled Tasks to schedule a book publication, you need to be an administrator of your machine or you need to be granted certain Windows rights. 1. SelectEPM > Book Publication > Publish Books. The Book Publication Wizard opens. 2. Select Schedule the Publication and click Next. If a schedule has already been defined for the current connection, the schedule is displayed. Note: You can only use one Windows Sheduled Task per connection. • If no schedule exists for the current connection or if you want to modify the schedule, click Next, enter the schedule information, enter your Windows account password twice, and click Next again. Note: • • • The Enable Schedule option is selected by default, meaning that Windows Sheduled Task is activated by default. The schedules you create are automatically saved for the current connection in the Windows Scheduled Tasks. If you want to deactivate the current Windows Sheduled Task, click the Windows Sheduled Tasks button. The Scheduled Tasks screen opens. Follow the Windows standard procedure: right-click the sheduled task, then select Properties. In the Task tab, uncheck the Enabled option. 3. To print the books: a. Select Printer. b. Enter the printer path or select it, using the ellipsis button. c. Depending on the printing order you want, you can select the Print all sheets for one dimensions members combination option. d. To specify that a sheet be printed even if none of the reports in the sheet contain any data, select the Print sheets with no data option. 4. To generate the books in PDF format: a. Select Publish to PDF Format. b. By default, one PDF file by combination of variable members is generated. If you want to generate all the books in one single PDF, select the Single PDF option and click Next. Enter a name for the PDF and select the local folder in which you want the PDF to be generated. When using a Planning and Consolidation connection, you can specify other folders than a local folder, in which you want the PDF to be generated, depending on your rights: public, private, team. 221 2013-09-04 but with a different dimension member (or a combination of dimension members) of the dimension(s) for which variable dimension members have been defined. The workbooks are stored in the specified folder or they are sent by email to the recipients you have specified in the template. based on: • one or more reports. 31. by default. When creating your input forms. 222 2013-09-04 . then the template sections you want to use to generate the books. When using a Local or an SAP BusinessObject Enterprise connection. Each automatically created workbook displays the initial report(s). You can make workbooks (containing reports or input forms) available to a set of users: • You can send the workbooks as attachments in emails. every Friday at 11:00 PM).Collaboration 5. the books in PDF format are stored at the following local location: C:\Documents and Settings\[UserWindows]\Local Settings\Temp\_PATH_PUBLISH. You can then select the template and sections you want.2. Data Collection Purposes When using a Planning and Consolidation connection for data collection purposes. Click Next. you can launch the distribution or you can schedule it (for example. 7. Using a template. place the dimensions you want in the various axes. you must ensure that the members are specified and fixed for all dimensions in all of the input forms you distribute. if one PDF by combination of members has been generated (and not one single PDF).2 Distribution and Data Collection Applies to: The Data Collection feature only applies to Planning and Consolidation connections. you can generate workbooks. • You can store the workbooks to a specific location. you make available to users workbooks that contain input forms. Click Process. apply one of the two following procedures: • First possibility: 1. Then. You do not want to depend on the context. When using a Planning and Consolidation connection. 6. Caution: To save the entered data to the server for the appropriate members. you can select a team so that all the templates for the selected team are displayed. Select the templates. A summary displays information about the books to be generated. To do so. at one time. • one or more variable members for one or more dimensions. The template specifies the information you want to include in the workbooks. This may be confusing. You do not want to depend on the context. Take all the remaining dimensions . • Second possibility: you lock the dimensions for the workbooks.meaning the dimensions that are not placed in any of the three axes . 4.2. note that users who do not have the EPM add-in installed and who will enter data. For more information about the context lock. specify the members that you set as variable. will not view the dimensions and members that are not included in the input forms.meaning the dimensions that are not placed in any of the three axes . the sections and the report workbook descriptions. However. note that users who do not have the EPM add-in installed and who will enter data. You must use all the dimensions in your input forms and in the distribution template. However. will not view the dimensions and members that are not included in the input forms. The users then enter data in the distributed workbooks and make them available: if the input forms have been sent to them by email. Caution for data collection purposes: To save the entered data to the server for the appropriate members. 3. Specify all the other dimensions as fixed members. see Context. Specify all the other dimensions as fixed members. Take all the remaining dimensions .1 Distribution Template Before distributing workbooks. you must ensure that the members are specified and fixed for all dimensions in all of the input forms you distribute. Note: Choose carefully the names you enter for the distribution template. When creating your input forms. you must create a distribution template.and place them in the page axis. they can send them back by email once they have finished entering data. In the distribution template. 3. you must use all the dimensions in your input forms and in the distribution template.2. The user that has distributed the workbooks can then collect the workbooks. 4. since they appear as the names of the folders. 31. specify the members that you set as variable. For more information about the context lock. 2. place the dimensions you want in the various axes. In the distribution template. using the Context Options dialog box. 223 2013-09-04 . apply one of the following two procedures: • First possibility: 1. To do so. including specific settings on dimension members. using the Context Options dialog box. This may be confusing. The data entered by the various users is automatically saved to the server. In a nutshell.and place them in the page axis. see Context. • Second possibility: you lock the dimensions for the workbook.Collaboration 2. • When using a Planning and Consolidation connection. If no member is selected for the Time dimension in a section of the template as a variable or fixed member. Note: The workbooks you select must contain reports or input forms that have the same connection as the template. • When using a Planning and Consolidation connection. A template can include one or more sections. The entered name is displayed on the section tab. the members selected as variable will override the members if the dimension is displayed in the page axis or in the context of the report.Collaboration • • • You should not use the following characters. When launching the distribution. Note: The tab of a section has no name until you enter it in the Section Name area. enter either the user names or the email addresses of the users. A section is a part of the template. A fixed member overrides any other member of the same dimension that is part of the report in the context or the page axis. 2009 will be taken into account. Creating or modifying a template consists of the following steps: • Enter a name for the template. They are mutually exclusive. Select the workbooks containing the reports or input forms you want to generate using the current template. the Variable Time field is displayed. Each section includes at least a selection of variable dimension members. • In the workbooks. • • Enter a name for the section. you will be able to select the sections of the template you want to take into account. For a specific dimension. • Section definition. Otherwise. One workbook is created for each member selected. If you select a Time member in a section. • • Enter a description for the workbook you have selected. the time member selected here applies to all the sections of the template and is hard-coded. it overrides the member selected in the Variable Time field for this section. Dimension member selection: • One or more dimensions for which one or several members are variables. Note: You cannot select fixed and variable members for one dimension. Workbook selection. • One or more dimensions for which only one member is fixed. The user you specify receives the report that is generated on this variable member. A user is associated to each variable member. the members are displayed according to the following precedence rule: 224 2013-09-04 . A section name and a workbook description must be unique within a template. enter the email addresses of the users. you cannot save the template. For example. if you select the period 2009 as a fixed member and the period 2008 is displayed in the page axis of the report. as they are changed into the _ character in the folders and book names: \ / : * ? " < > | & + = ( ) { } [ ] $ % You should not enter a space at the beginning or the end of the names. • When using a Local or SAP BusinessObjects Enterprise connection. 3. since they appear as the names of the folders. 225 2013-09-04 . under the section tab. Save as and Validate commands available inEPM > Distribution. • 1. meaning without using the dialog box dedicated to the publication template. A section name and a workbook description must be unique within a template. 31. you must specify another workbook that contains valid reports. including: • You can open an existing template. the template opens but the report workbook area is empty. If you want to save your template.1. • • • You can create a blank section or a section based on an existing one. If you want to create a template on a different connection. If you are using a Planning and Consolidation connection. These actions are available in the template dialog box. The Distribution Template dialog box opens. Enter a name for the template. Other actions are available on a template. modify it and save it with a different name by selectingEPM > Distribution > Open Template. Otherwise. it is saved as an . 3. you cannot save the template. Note: Once you have created a template. members in the row and column axes. 2.2. See Open Actions.2. If you have opened a Plannning and Consolidation publication template using the EPM > Open > Open Server Root Folder. as they are changed into the _ character in the folders and book names: \ / : * ? " < > | & + = ( ) { } [ ] $ % You should not enter a space at the beginning or the end of the names. members in the page axis. Note: • If a report workbook specified in the template does not contain valid reports. 4. In the template dialog box of a template created on a Planning and Consolidation connection. 2. members in the context.Collaboration 1.1 Creating Distribution Templates Note: • A template is created by default on the first connection used in the workbook. the sections and the workbook descriptions.xlt or xltx file. you can use the Save. the Save the template in a different location is available and enables you to choose another location on the server to save the template. Select EPM > Distribution > New Template. members selected as fixed members or as variable members in the distribution template. • • • You should not use the following characters. You can also delete a section from the template. selectEPM > Distribution > Change Connection. you can select a member of the Time dimension using the Variable Time field. Choose carefully the names you enter for the distribution template. A template can only apply to reports or input forms using the same connection. 12. Select the checkbox for a dimension and click the Add button of the area you want. Then. click the button next to it and select the members you want in the Member Selector. you can select dimensions for fixed members. The template is saved to the following local folder: C:\Documents and Settings\[UserWindows]\My Documents\PC_LOC\ [login]\books\[appset]\[application]\[team or localTeam]\WebExcel\ManageBook C:\Documents and Settings\[UserWindows]\My Documents\PC_LOC\ [login]\books\[appset]\[application]\[team ou localTeam]\WebExcel\ ManageDistributionList. 226 2013-09-04 .xltx) and enter a name for the template file. The Dimension Selector opens. You can only select one member per dimension as a fixed member. You can select other workbooks and enter a description for them by clicking the green cross icon. Click OK. perform the following action: • When using a Planning and Consolidation connection. For each variable dimension. For each dimension selected. Note: Once a dimension has been selected. select a format (. when using a Local or SAP BusinessObjects Enterprise connection. You must add at least one dimension in the Variable Members area. Click Select Dimensions. Note: The reports or input forms and the template must be connected to the same source. You can create one or more sections by clicking the Add New Section button and repeat steps 4 to 10. 10. 9. check that you have performed all the above steps and check also that the names of the sections and the workbook descriptions you have entered are unique within the template. you can select an additional member by clicking the green cross icon.xlt or . 13. Enter a name for the section. in the Save As dialog box. The entered name is displayed on the tab of the section.xlt or . Note: If the Save button is disabled. 6. Click Save. in the Save dialog box. 7. • When using a Local or SAP BusinessObjects Enterprise connection. 5.Collaboration 4. 11. 8.xltx) and enter a name for the template file. select a format (. The user you specify receives the report that is generated on this variable member. enter: • the email address of the user. • the user name or the email address of the user when using a Planning and Consolidation connection. Depending on the connection you are using. Select a workbook that contain the reports or input forms you want to generate and distribute and enter a description for the workbook. so that the distribution can be performed. If you want to send the workbooks by email (and if you do not work on a Planning and Consolidation connection that returns the SMTP server information). You can send the workbooks by email as attachments. you must have defined a distribution template. • Basic • NTML • • If you have selected the basic or the NTML authentication type.2. Distribution Scheduling • • The schedules you create are automatically saved for the current connection in the Microsoft Windows Scheduled Tasks. • The port number. meaning that the users will be able to work with a workbook in a disconnected state without using the EPM add-in. you 227 2013-09-04 .2. Select the Enable SSL option if needed. you do not need to enter the SMTP information in the User Options. you need to be administrator of your machine. Enter the following information in the SMTP Server Configuration area of the User Options dialog box: • The SMTP server address. you can still use Windows Scheduled Tasks if you are granted certain Windows rights. For more information. The workbooks are automatically switched to offline. If you are not (for security reasons).Collaboration 31.2. SelectEPM > Options > User Options. you must enter the login and password of the SMTP server. so that the distribution can be performed.com/kb/883273/en-us. the port number is 25. you must enter the required information about the SMTP server you use to send the emails. or store them at a specific location. • Select the authentication type: • Anonymous. If you select this type. As you use Windows Scheduled Tasks to schedule a book publication.2. you can distribute the workbooks now or schedule the distribution.1 Launching Distribution • • Before launching a distribution. no authentication is required and you do not need to enter the information in the Authentication area. 31. As a general rule. Distribution by Emails If you want to send the workbooks by email.2.2 Workbook Distribution Once you have created a template. Note: If you work on a Planning and Consolidation connection and if this connection returns the SMTP server information.mi crosoft. see http://support. When using a Planning and Consolidation connection. enter the path to the folder in which you want to save the workbooks or select the path by using the ellipsis button. Since you use MIcrosoft Windows Scheduled Tasks to schedule a distribution. Select Switch to offline mode and save to folder and click Next. Select the templates. In the Folder Location area.2. select the location where the template you want to use is stored (Public or a specific team). Click Next. SelectEPM > Distribution > Distribute. b. you need to be administrator of your machine or you must be granted certain Windows rights. Select Distribute Now and click Next. 228 2013-09-04 . SelectEPM > Options > User Options and enter the SMTP information in the SMTP Server Configuration area. 2. Select Schedule the Distribution and click Next. the schedule is displayed. according to the users specified for each variable member in the distribution template. you must have previously defined a distribution template. b. then the template sections you want to use to generate the workbooks.Collaboration must enter the required information about the SMTP server you use to send the emails. you can select a team so that all the templates for the selected team are displayed. 2. 1. The distribution is launched and the process steps are displayed. enter the schedule information. 5. 1. Enter standard email information. You can then select the template and sections you want. 31. enter your Windows account password twice. 7. If you are using a Planning and Consolidation connection.2 Scheduling Distribution • • Before launching a distribution.2. If a schedule has already been defined for the current connection. • If no schedule exists for the current connection or if you want to modify the schedule: click Next. To save the workbooks to a specific folder: a. The Distribution Wizard opens. 3. To send the workbooks by email: a. Select Switch to offline mode and send by email and click Next.2. 6. 4. A summary displays information about the workbooks to be generated. The workbooks are generated and stored in the specified folder or the workbooks are sent by email as attachments. The Distribution Wizard opens. and click Next again. Note: You can only use one Windows Sheduled Task per connection. SelectEPM > Distribution > Distribute. uncheck the Enabled option. In the Folder Location area.1 Collecting Data To collect data. A summary displays information about the reports to be generated. The Scheduled Tasks screen opens. meaning that Windows Sheduled Task is activated by default.3. b.2. If you want to deactivate the current Windows Sheduled Task. The entered data is automatically saved to the server. 229 2013-09-04 .2. Follow the Windows standard procedure: right-click the sheduled task. Enter standard email information. Select Switch to offline mode and send by email and click Next. The sender can then collect the workbooks from the specified folder or the email folder. 31. or replace the workbooks in the specified distribution folder. Click Process.2. In the Task tab. To save the workbooks in a specific folder: a. When using a Planning and Consolidation connection.3 Data Collection Applies to: Planning and Consolidation connections. 4. they can either email the workbooks back to the sender. 3. Select the templates. 5. 6. then select Properties. The Collection Wizard opens. 7. enter the path to the folder in which you want to save the workbooks or select the path by using the ellipsis button. If users have entered data in the distributed workbooks. SelectEPM > Distribution > Collect. b. 1. click the Windows Sheduled Tasks button.2.Collaboration Note: • • • The Enable Schedule option is selected by default. You can then select the template and sections you want. The schedules you create are automatically saved for the current connection in the Windows Scheduled Tasks. you must have previously performed a workbook distribution on the same connection. then the template sections you want to use to generate the workbooks. Select Switch to offline mode and save to folder and click Next. To send the workbooks by email: a. 31. Click Next. you can select a team so that all the templates for the selected team are displayed. Do one of the following: • To collect data entered in workbooks that users have sent you by email. In the Microsoft Outlook dialog box. select the Outlook folder in which the emails with the workbooks are stored. select the workbooks that you want to collect and click Next twice. • To collect data entered in workbooks that users have stored in a specific folder. select the Local Folder option. select the folder containing the workbooks you want to collect.Collaboration 2. 230 2013-09-04 . then click the ellipsis button in the Working Folder area. select the Outlook Mailbox option. select the emails containing workbooks that you want to collect and click Next twice. In the dialog box that opens. then click the ellipsis button in the Working Folder area. The workbooks are automatically connected and the data is saved to the server. Back in the Collection Wizard. Back in the Collection Wizard. All the functions are available for selection. Using this dropdown list. • You can enter an EPM function directly in the formula bar. To make it easier to create and edit formulas and minimize typing and syntax errors. The EPM dedicated functions are gathered under the EPMFunctions category. you can directly select another connection or you can select the command Select Another Connection. a dynamic dropdown list of all the EPM functions is displayed below the cell.TechnicalCategory category is only used internally and must not be used by other users.EPM Functions EPM Functions The EPM functions are formulas that enable you to retrieve specific information or data and to make a report behave in a certain way. as it is not case-sensitive). add-in for Microsoft Office What's New guide. For example: "account". From version 10. An EPM function is created by default on the active connection of the sheet. see the SAP BusinessObjects EPM Solutions. then select another connection in the Connection Manager that opens. regardless of the data source. Note: • For technical reasons. the names of the functions begin with EPM. Note: • • You should deactivate the Member Recognition and the Local Member Recognition functions when using the EPM functions. • The string parameters must be entered between the "" characters. providing power and flexibility to reports. some functions beginning with Ev continue to work but their names are not automatically converted into EPM. The FPMXLClient. All the functions beginning with Ev are grouped under the EVFunctions (Deprecated) category. After you type =epm (or =EPM. The default connection is displayed in the Active Connection dropdown list of the EPM pane. use Microsoft Office Excel Formula AutoComplete. If you work with reports that have been created with previous versions of Planning and Consolidation (before version 10). • • 231 2013-09-04 . • The separator character used to separate the parameters of a function depends on the "list separator" defined in your local settings. General notes: • The text entered in formulas is not case-sensitive. For more information on the former names and the corresponding new names. the functions that are not supported on a specific data source are not greyed out or hidden in the EPMFunctions category. • You can also use the Microsoft Office Excel standard Insert Function dialog box by clicking the Insert Function button from the EPM tab of the ribbon. EPM Functions • • This note applies to Planning and Consolidation Local connections. EvLST. Note: When the sheet option Perform Worksheet Refresh on Expand/Collapse is selected. You create a local member that contains the EPMCommentPartialContext function. EvDLK. the refresh time can be longer since the whole worksheet is refreshed.0 (on a 10. EvSEN. OsAMT. EvPOV. This prevents conflicts between EV function names. EvENE. EvSET. EPM Function Refresh When creating or modifying EPM functions. EvCLK. EvBLK. they are executed immediately. However. See the example below. EvEXP. EvLIK. The EPM functions that need to retrieve information from the server are executed only when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. changes in the Report Editor. the whole worksheet is automatically refreshed on an expand or collapse action when the sheet option Perform Worksheet Refresh on Expand/Collapse is selected. EvPLK. EPMExecuteAPI. Collapse. the expand action automatically performs a refresh of the current report and not of the 232 2013-09-04 . We recommand that you use this option if you use reports on which you perform a lot of expand or collapse actions. when using both add-ins. • The following Ev functions are not supported in the EPM add-in: EvALK. changes in the page axis.5 (on a 7. Keep Member.0 Planning and Consolidation model). Example: You want to retrieve the comments for the accounts that are placed in the rows of the report. EvNXP. uncheck the Load EV Functions option in the User Options of the EPM tab. Planning and Consolidation Interface for Excel 7. See example below. EvPXR. • EvMNU name is still supported but its former parameters are not recognized by the EPM add-in. EvSLK. 2011 Total Personnel Costs 2356 fn (local member with EPMCommentPartialContext) ok You expand "Personnel Costs". EvASV. The data and comments are displayed from the server. EvMSG.provided that the sheet option Perform Worksheet Refresh on Expand/Collapse is not selected. A simple refresh of the report does not execute the EPM function.5 Planning and Consolidation model) and EPM add-in 10. For more information about the new parameters. and EPM function data is not displayed in the report until you perform a refresh of the worksheet or workbook. • By default . EvMEM. The EVFunctions (Deprecated) category does not appear. EvINP. Note: The following actions automatically refresh the selected report (not the whole worksheet): Expand. Click Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. However. Exclude Member. with the exception of several functions. or if you use reports that contain local members with EPM functions that retrieve data or comments. It is the same for the data. Note: • The Use EPMMemberID in EPM formulas option and the Insert EPMMemberID in Formulas command apply to both EPM functions and local members. • if only the description or the ID of the EPMOlapMemberO is displayed in the report and if the description or the ID is not unique in the data source. EPMMemberID(B4). the EPMMemberID function is added. when this option is selected. your report contains a mix of data. #RFR is displayed instead in the cells. you need to perform a refresh of the whole worksheet or workbook. For any cell references containing members. it is still recommended that you use the EPMMemberID function. For all the EPM functions that have been created when the option was not selected. since a worksheet refresh is performed on the expand action. B4. selectEPM > More > Insert EPMMemberID in Formulas. 233 2013-09-04 . you must use the EPMMemberID function in the two following cases: • if the ID and the description of the EPMOlapMemberO are displayed in the report. Example: example with the EPMMemberProperty function Do not define the function as follows: =EPMMemberProperty("connection1". As the EPMCommentPartialContext retrieves comments from the server. comments and #RFR: this is the default behavior. you can scan all the formulas of the current worksheet.EPM Functions current worksheet. To do so. "HLEVEL") Define the function as follows: =EPMMemberProperty("connection1". A6 is automatically replaced by EPMMemberID(A6) if A6 contains an EPMOlapMemberO function. In other cases. data and comments are displayed. when you reference a cell that contains an EPMOlapMemberO member. To scan all the formulas. when you reference a cell that contains a member placed in one of the three axes of the report (meaning a member identified by =EPMOlapMemberO). the "EPMMemberID" function is automatically added. 2011 Total Personnel Costs Bonus Expense 2356 #RFR fn (local member with EPMCommentPartialContext) ok #RFR #RFR #RFR Wages and Salaries #RFR Social Contributions #RFR • Click Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook: data and comments are displayed and occurrences of #RFR are removed from the cells. "HLEVEL") Note: You can also specify that for each EPM function formula that you create. For example. Therefore. Referencing an EPMOlapMemberO In an EPM function formula. If you select the sheet option Perform Worksheet Refresh on Expand/Collapse. the comments are not displayed at this stage. To display all data and comments. if you reference cell A6. select the Use EPMMemberID in EPM formulas option in the User Options. Description. The member retrieved is the one for which you have entered the ID. INFO (depending on its arguments). Related Topics • Logon and Connections 32. As a reminder. CELL (depending on its arguments). ID. the following Microsoft Excel functions are volatile: NOW. member W will be retrieved. Example: the ID of member M equals the description of member W. note that selecting this option may lower performances. When you enter the description of member M as the parameter of an EPM function. INDIRECT. as the system searches for IDs first. For more information about the names of members. 234 2013-09-04 .EPM Functions • However. Use of Volatile Functions As mentioned in the Microsoft Excel documentation.1 EPMUser This function retrieves the login for the specified connection. RAND. OFFSET. TODAY. see Display Name. Retrieved Members The EPM add-in searches for members according to the following order: Full unique name. the use of too many volatile functions can lower the recalculation performances. provided that you are not connected to other models that have the exact same name. the active connection is taken into account. provided that you are not connected to other models that have the exact same name. This is optional.2 EPMServer This function retrieves the server address for the specified connection.3 EPMEnvDatabaseDesc This function retrieves the description of the environment or database for the specified connection. Parameter Description connection name Name of the connection. Note: • • For better performance. You also have the option to enter the name of a model instead of the connection name. SAP recommends that you always enter a connection name. Note: • • For better performance. the active connection is taken into account. If not specified.EPM Functions Parameter Description connection name Name of the connection. 32. 235 2013-09-04 . This is optional. You also have the option to enter the name of a model instead of the connection name. SAP recommends that you always enter a connection name. If not specified. 32. provided that you are not connected to other models that have the exact same name.4 EPMEnvDatabaseID This function retrieves the name of the environment or database for the specified connection. This is optional.5 EPMModelCubeID This function retrieves the name of the model or cube for the specified connection. 32. provided that you are not connected to other models that have the exact same name. 32.EPM Functions Parameter Description connection name Name of the connection. If not specified. the active connection is taken into account. the active connection is taken into account. Parameter Description connection name Name of the connection. Note: • • For better performance. SAP recommends that you always enter a connection name. You also have the option to enter the name of a model instead of the connection name. Note: • • For better performance. If not specified. SAP recommends that you always enter a connection name. This is optional. 236 2013-09-04 . You also have the option to enter the name of a model instead of the connection name. 7 Functions on Reports Some EPM functions enable you to perform certain actions on reports. perform a refresh on the worksheet.6 EPMModelCubeDesc This function retrieves the description of the model or cube for the specified connection. Parameter Description connection name Name of the connection. After you enter a function. This is optional. provided that you are not connected to other models that have the exact same name. the functions are not moved with them. 32. SAP recommends that you always enter a connection name. You also have the option to enter the name of a model instead of the connection name. the active connection is taken into account. Note: • • For better performance. you should enter the functions above the reports. Note: • • For better performance. Therefore. Leave a blank row or column between the function and the report. You also have the option to enter the name of a model instead of the connection name. If not specified. provided that you are not connected to other models that have the exact same name. This is optional.EPM Functions Parameter Description connection name Name of the connection. the active connection is taken into account. • 237 2013-09-04 . Note: • Do not enter the functions right next to a cell of a report. 32. if you move the reports. If not specified. SAP recommends that you always enter a connection name. Also. • In report 001. the second member override definition is applied to the second report. • • • In report 002.PLAN | ACTUAL") • In report 000. If you define more reports than member override definitions.7.001. The fourth member override definition ACTUAL is not applied to any report."Category". For example: "000. the Category dimension members are overridden by the members ACTUAL and FORECAST. Note: Use the . using the reportID parameter. enter: dimension. The dimension member selection performed in the Member Selector is replaced by a specific cell or range of cells.1 EPMDimensionOverride This function overrides the member selection for a specified dimension in one or several reports.EPM Functions 32. members reportID parameter You can apply the selection to one or more reports.FORECAST. Parameter Description reportID dimension ID of one or several reports On a Planning and Consolidation connection. specify the dimension name. you can use the | character in the members parameter to separate the member override definition. to specify a hierarchy. If you specify several reports in the reportID parameter. For other connections. FORECAST and PLAN and ACTUAL.002". specify the hierarchy name. For example: =EPMDimensionOverride("000. The first member override definition is applied to the first report.001". the Category dimension members are overridden by the member PLAN. The members override the members previously selected in the report. 238 2013-09-04 . character to separate the reports.FORECAST | ACTUAL. the Category dimension members are overridden by the members ACTUAL. where 000 corresponds to the first report of the sheet (also called the default report) and 001 corresponds to the second report of the sheet." PLAN | ACTUAL.hierarchy Members you want to select for the specified dimension. and so on. • In report 002. • The fourth member override definition ACTUAL is not applied to any report. the Category dimension members are overridden by the members ACTUAL. • If you define more member override definitions than reports. the exceeding member override definitions will not apply to any report. FORECAST and PLAN. the exceeding reports will use the last member override definition. Retrieves all the base level members that are below the context member of the dimension. For example: =EPMDimensionOverride("000". Note: The master report takes precedence over the other reports.including the members in the intermediate levels. • DEP.EPM Functions For example: =EPMDimensionOverride("000. until the level n in the hierarchy .TOTAL) retrieves the semester and the quarter members of 2008. This value cannot be used alone. or displaying totals to the right in the column axis. • LDEP(n).2008. Retrieves all the members of the dimension. you can use the following values to specify a dynamic selection of members: • MEMBERS. For example: LDEP(2. Context member."'99 . • LBAS(n).002.PARENTAFTER. Retrieves all the base level members that are below the context member of the dimension. • In report 002. • In report 000. • In report 003. Retrieves all the descendants of the context member of the dimension. LBASMEMBERS(n).003". For example: LDEP(2. the Category dimension members are overridden by the ACTUAL member. you can use the y character to retrieve only the members for the level specified by n. members parameter For the members parameter. • SELF.including the members in the intermediate levels.TOTAL.including the members in the intermediate levels. In addition. • BASMEMBERS." PLAN | ACTUAL"). • ALL. Retrieves all the base level members of the "all" member of the dimension until the level n in the hierarchy . Retrieves all the members of the dimension."FL".Y) retrieves only the quarter members of 2008. Retrieves the context member of the dimension. enter member names in ' ' (single quotes) or " " (quotation marks) when member names contain spaces or special characters."Category". Retrieves all the base level members of the dimension. the Category dimension members are overridden by the PLAN member. In addition. displaying the totals at the bottom in the row axis. 239 2013-09-04 . you can optionally use the y character to retrieve only the members for the level specified by n. • BAS. Note: • • The values above are not case-sensitive. you can optionally use the y character to retrieve only the members for the level specified by n.001. • In report 001. LMEMBERS(n). you can use the y character to retrieve only the members for the level specified by n. If you change the member in the context. Retrieves all the children of the context member of the dimension. Retrieves all the descendants of the context member of the dimension until the level n in the hierarchy . For example: MEMBERS. PARENTAFTER. the Category dimension members are overridden by the ACTUAL members. To ensure that members are recognized as members. the Category dimension members are overridden by the ACTUAL members. Retrieves all the descendants of the "all" member of the dimension until the level n in the hierarchy . Optionally.including the members in the intermediate levels.2008.Closing Balance'") • • • Examples: • SELF. Optionally. the member is updated in the report. enter: dimension. Context member and its children. To specify a dimension.. member1 is ber5 mandatory.EPM Functions • • SELF. Dimension1 is not mandatory member1. the dimension change is taken into account in the EPMAxisOverride function. specify the hierarchy name.. via the EPMDimensionList function. 32. the member override is reflected in the EPM pane. FALSE to override the column axis. Note: • • • • You can specify cells that are either in the current sheet or in other sheets. See EPMDimen sionOverride. Context member and its descendants. To reflect the override.. DEP and if. to specify a hierarchy. This function is dynamic. for example.Members that override the members currently in the report(s). for the Account dimension. to mem. a child of the context member is deleted in the data source. For example. refresh the report. you can select the cell in which a dropdown list retrieves the dimensions. ALL. • • For the members parameter. For other connections. it is also deleted from the report. SELF. If another dimension is selected from the dropdown list. meaning that if you have specified SELF. You can enter any Microsoft Office Excel formula. using the reportID parameter. see EPMDimensionOverride. but not in the report. Specify which axis is overriden. Use the Planning and Consolidation technical name of the properties and property values.2 EPMAxisOverride This function overrides one or several dimensions (and their members) for a specified axis (row or column axis). DEP. you can enter a property selection: property=propertyvalue. When you enter the function and then click Enter. • You can apply the selection to one or more reports. Parameter Description reportID row axis dimension1.7. Enter TRUE to override the row axis. Mandatory. Mandatory. 240 2013-09-04 . Note: The master report takes precedence over the other reports. you can enter ACCTYPE=INC to retrieve all the income accounts.. specify the dimension name. When using a Planning and Consolidation connection. to dimension5 ID of one or several reports.hierarchy. On a Planning and Consolidation connection. For example: "000. • • You can add the range to one or more reports. a message appears. If the source range is added to a blank zone (shift) of the report. fixed text and data validation settings. data. 241 2013-09-04 . where 000 corresponds to the first report of the sheet (also called the default report) and 001 corresponds to the second report of the sheet. and if the source range is larger than the blank zone. Only empty cells will not be added to data cells. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. the following content of the source range is duplicated as long as the report range has not been reached: all the format settings. If the description of a member exists in several dimensions. using the reportID parameter. in the report cells that do not contain any data. stating that the description is ambiguous and recommending that you use the ID of the member instead. Note: Use the . formulas. data. a message appears. once you have entered the function. formulas. The range is added to the data grid and in the shift zones (if there are any). If the source range that you want to add is smaller than the report range.EPM Functions Note: • • • • Do not use the EPMAxisOverride function more than once on the same axis and the same report. fixed text and data validation settings. By default. If you enter one function for the row axis and one for the column axis. starting after the row axis and below the column axis. If you want to add the following content to the report cells that contain data.001". the following content of the specified source range is added to the report cells that contain data: all the format settings and formulas. the row axis takes precedence over the column axis. the beginning of the source range is added to the blank zone and the rest of the source range is duplicated in the data grid. character to separate the reports. formulas. • • Related Topics • EPMDimensionOverride • EPMDimensionList 32. once you have entered the function.3 EPMCopyRange This function enables you to add and repeat the content of a range of cells until the bottom (columns) or the right side (rows) of a report is reached.7. fixed text and data validation settings. enter TRUE in the copyAllOnCopyRange parameter: all the format settings. If the ID of a member exists in several dimensions. • • The following content of the specified source range is added to the report cells that do not contain any data: all the format settings. hierarchy Specify where the cells must be inserted. to specify a hierarchy. Specify if all content types are added to the report data.4 EPMInsertCellsBeforeAfterBlock This function inserts cells before or after a block of members for a specified dimension. Enter TRUE to copy all content types. you must specify both IDs (using 242 2013-09-04 . here is how the EPMCopyRange function behaves: if the axis that is specified in the EPMCopyRange function (using the Rows parameter) is not the master axis. An inserted member is identified by a formula beginning with =EPMInsertedMember(. the EPMCopyRange function is simply ignored. enter FALSE. FALSE to add the cells in columns. Enter TRUE to add the cells in rows.EPM Functions Parameter Description reportID Rows SourceRange copyAllOnReportData ID of one or several reports Specify where the range will be added. Parameter Description reportID Dimension ID of one or several reports On a Planning and Consolidation connection. enter: dimension. you specify only the master report ID (using the reportID parameter). here is how the EPMInsertCellsBeforeAfterBlock function behaves: if you want to insert the cells in the master report only. Otherwise. For other connections. if you want to insert the cells only in a child report. If the source range that you want to insert is smaller than the destination range in the report: • the first cells of the source range are inserted before the block of members. Note: When several reports share an axis. • the subsequent exceeding cells of the source range are copied and duplicated in all the cells of the destination range until the end of the report is reached. specify the hierarchy name. Specify the cell range containing the content that will be added to the rows or columns. 32. Enter TRUE to insert the cells before the members. specify the dimension name.7. FALSE to insert the cells after the members. Note: The inserted cells are considered as "false" members. Specify the cell range containing the content that you want to insert Before Range Note: When several reports share an axis. The override applies to a report only if the Inherit Sheet Options option is not selected in the Options tab of the Report Editor. if you want to insert the cells in several child reports. A unique name includes the following: [dimension name]. To activate this option. character to separate the options. In the options parameter.EPM Functions the reportID parameter): the ID of the master report and the ID of the child report. Mandatory. Note: All the report options are not described in this section. 243 2013-09-04 .[member name] Parameter Description member Cell that contains a member for which you want to retrieve the unique name. Mandatory. 32. 32. Following is the list of values correponding to the report options: • CalculateParentsInHierarchies. you can specify one or more options. see Calculate Parents in Hierarchies. You must always specify the master report ID. To deactivate it.7. Specify the options that will override the existing ones. Parameter Description reportID options ID of one or several reports. Follow the links for descriptions of the options. enter: " CalculateParentsInHierarchies=true".5 EPMMemberID This function retrieves the unique name of a specified dimension member that is included in a report.7. Use the . To deactivate it. enter: " CalculateParentsInHierarchies=false" For more information.6 EPMReportOptions This function overrides the options for one or more reports. To activate this option. enter: "KeepFormulaOnData=true". you must specify all IDs (using the reportID parameter): the ID of the master report and the IDs of the child reports.[hierarchy name]. enter: "KeepFormulaOnData=false". • KeepFormulaOnData. that is an EPMOlapMember or an EPMOlapMemberO. Mandatory. enter: "KeepEmptyRows=true ". To activate this option. To activate this option. To activate this option. To deactivate it. • FreezeDataRefresh. • No indentation. see Repeat Row Headers and Repeat Column Headers. Enter what follows in the options parameter: "SetDefaultValueInEmptyCell=true". enter: "KeepEmptyRows=false" For more information. enter: "SetDefaultValueInEmptyCell=false" Then. • TotalAtTop."EmptyCellDefaultValue=no data" For more information. • RepeatRowHeaders. to define a default value. enter: "FreezeDataRefresh=true". see No Data and Zero Values. To deactivate it. enter: "RepeatRowHeaders=true". To activate this option. To deactivate it. enter: "ShowSourceDataInComments=false" For more information. enter: "SetDefaultValueInEmptyCell=true". Enter: "RowHeaderIndentation=0" • Indent the children. enter: "RepeatRowHeaders=false" For more information. • TotalAtLeft. Enter: "RowHeaderIndentation=1" • Indent the parents. To deactivate it. To deactivate it. Three values are possible. see Totals Placement . To deactivate it. see Freeze Data Refresh. enter: "RepeatColumnHeaders=true". To activate the option. Enter: "RowHeaderIndentation=2" For more information. enter: "TotalAtTop=true". To activate this option. To activate the option. To deactivate it. enter: "KeepEmptyColumns=false" For more information. see Keep Formula on Data and Show Source Data in Comments . To deactivate it. enter: "RepeatColumnHeaders=false" For more information. • KeepEmptyColumns. see Empty Cell Default Value . enter: "TotalAtTop=false" For more information. enter: " ApplyDynamicFormatting=true". see Row Header Indentation . • SetDefaultValueInEmptyCell and EmptyCellDefaultValue. see Totals Placement . • KeepEmptyRows. • ShowSourceDataInComments. To activate this option. To deactivate it. see No Data and Zero Values. enter: "EmptyCellDefaultValue=[string]" For example. enter: "TotalAtLeft=true". enter: "KeepEmptyColumns=true". • ApplyDynamicFormatting and FormattingSheet. • RowHeaderIndentation. enter: "TotalAtLeft=false" For more information. see Repeat Row Headers and Repeat Column Headers. you want that "no data" appears in any cell that contains no value. see Keep Formula on Data and Show Source Data in Comments . 244 2013-09-04 .EPM Functions For more information. enter: "ShowSourceDataInComments=true". enter: "FreezeDataRefresh=false" For more information. To activate this option. To activate this option. • RepeatColumnHeaders. For other connections.7 EPMMemberSortingOverride This function overrides the member sorting and grouping that has been previously defined using the interface (Member Sorting and Grouping area in the Member Selector)."RowHeaderIndentation=1". sort ascendingOrder 245 2013-09-04 ."FormattingSheet=templateCompany" For more information. enter: "FormattingSheet=[name of the sheet]" For example. to specify the sheet to apply. enter the following: EPMReportOptions=("000". in one or several reports. see Member Sorting and Grouping by Properties." ApplyDynamicFormatting=true". for a specified dimension. FALSE if you do not want to enable the sorting.hierarchy Specify if you want to enable the member sorting. Parameter Description reportID dimension ID of one or several reports On a Planning and Consolidation connection. Example: Example with several options To indent the child members in the row axis and to apply the dynamic formatting sheet called "global" to the default report. enter what follows in the options parameter: " ApplyDynamicFormatting=true". specify the dimension name. Enter TRUE to sort members by ascending order. see Apply Dynamic Formatting. specify the hierarchy name. enter: dimension."FormattingSheet=global") 32. to specify a hierarchy. For more information about how to sort or group members using the interface. Specify if you want to sort the members by ascending or descending order. Enter TRUE to enable the sorting.EPM Functions Then.7. FALSE to sort members by descending order. depending on the ascending parameter. in this case) Specify a cell range containing the data that you do not want to be saved on a save action. If not specified. AddLocalMember. you can reference the cell in which the EPMDimensionProperty function has been entered.Specify if you want to insert a grouping local member after the set of members. AddLocalMember. Parameter Description reportID Range 1 to. For more information.. The values of the specified property are ordered by ascending or descending order.EPM Functions Parameter Description property Name of the property on which to sort the members. Optional. you can also choose not to save the data entered on specific dimension members or at the intersection of specific members. Before Enter TRUE to insert the grouping local member. This function enables you to choose not to save the data entered on specific ranges or on the whole report. After Enter TRUE to insert the grouping local member.9 EPMSuppress 246 2013-09-04 .8 EPMReadOnlyData Applies to: Planning and Consolidation connections. EPMDimensionProp erty. 32. Related Topics • Member Sorting and Grouping by Properties 32..Specify if you want to insert a grouping local member before the set of members.7. ID of one report (input form. Tip: In the Property parameter.7. Note: For a specific input form. the whole report is taken into account. See Read-only Data. Specify if rows or columns that contain zero values be also removed.Dim1Membern • or {Dim1Member1. The member syntax is as follows: • Dim1Member1. For example: Plan.…. Additionally. • In the opposite axis of the report.. 247 2013-09-04 .{DimnMember1.…. In this case. you must specify the full member combination.Dim1Membern}. or outside of the report. If the members specified do not contain any data. If the specified member belongs to an axis that is shared by several reports. the opposite axis. FALSE for the column axis. When performing the remove on both row and column axis.2004 (see the syntax in the parameter Members in the table below).…. the rows or columns are removed.. • Outside of the report.…. Specify the members on which the suppress is based. The members specified can be: • In the same axis of the report. the remove is not performed.8 EPMReportID This function retrieves the unique name of the report from which you specify a member. Therefore.{Dim2Member1. Enter TRUE for the row axis. In order to perform a remove based on members belonging to dimensions that are placed in the current axis. the ID of the master report is retrieved. • In the page axis of the report. you must specify members that are part of the outer dimension. you cannot perform it on the same dimensions if these dimensions are not part of the report (either dimensions from the context or the page axis). you can specify to remove rows or columns that contain zero values.EPM Functions This function enables you to remove rows or columns. Dim2Membern}…. Restriction: • If the members specified belong to a dynamic and asymmetric axis. Specify the axis in which the remove will be performed. Description • Parameter reportID Row Members ID of one or more reports. based on specified members. ues 32.DimnMemberN} SuppressZeroVal. the relationship Dimension Property and the selection of excluded members on dynamic axis are not supported. separator reportID Separator character. provided that you are not connected to other models that have the exact same name. The list of members can be optionally filtered. For each dimension in the page axis. separated by the specified separator. a dialog box opens. This is optional. 000 (default report) is taken into account. SAP recommends that you always enter a connection name. The members are displayed in the selected cell. only the context members are displayed. 32.10 EPMContextMember This function retrieves the context member for the specified dimension. If not specified. 248 2013-09-04 . the List Separator of your local settings is used. You can select another member and the context is changed. Parameter Description connection name Name of the connection.EPM Functions Parameter Description reportMember Member name. Note: If the value in the ReportID is unknown. If not specified. the context member is overridden by the page axis member. Optional. When you double-click the cell containing the function. You also have the option to enter the name of a model instead of the connection name. displaying all the members for the specified dimension. Mandatory. 32. using the dimension properties.9 EPMFullContext This function retrieves for the specified connection the context dimension members and the members contained in the page axis for the specified report. If not specified. Note: • • For better performance. the active connection is taken into account. Specify the ID of one report. "CALC=N. the context member of the dimension Entity is displayed in the cell. This is optional. If you enter FALSE or do not specify anything.EPM Functions Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). Example: EPMContextMember("Finance". Optional. the double-click will not function. the active connection is taken into account. dimension filter context member name dimension name.11 EPMDimensionProperty This function retrieves the properties of a specified dimension in a specified cell range. If the cell on which you double-click is merged with other cells. provided that you are not connected to other models that have the exact same name. Optional. Displays the same member name as the one displayed the Context bar. For the Financial Consolidation connection.GROUP=SALES"). If you double-click the cell. Description Parameter connection name Name of the connection. 32. If not specified. SAP recommends that you always enter a connection name. a dialog box displays a list of all entity members filtered by CALC=N and by GROUP=SALES. If you enter TRUE. Filter by property to return only members with specified property values. 249 2013-09-04 ."Entity". You also have the option to enter the name of a model instead of the connection name. the member name that is displayed in the cell is the same member name as the one displayed in the Context bar. the ID of the member is displayed in the cell. Mandatory. Note: • • For better performance. If you select a smaller number of cells than the number of properties. 32. provided that you are not connected to other models that have the exact same name. You also have the option to enter the name of a model instead of the connection name. Optional. Mandatory. Cell range in which the properties are displayed. dimension destination range display ID Name of the dimension for which you want to return the properties.12 EPMDimensionPropertyValues This function retrieves the values of a specified property. SAP recommends that you always enter a connection name. not all the properties will be displayed.EPM Functions Parameter Description connection name Name of the connection. enter FALSE or do not enter anything. the active connection is taken into account. Specify whether you want to display the ID or the description of the properties. Mandatory. enter TRUE. 250 2013-09-04 . Note: One property is displayed in one cell. To display the ID of the properties. This is optional. If not specified. in a specified cell range. Note: • • For better performance. for a specified dimension. Therefore. you should select a large destination range. To display the description of the properties. 13 EPMMemberDesc This function retrieves the description of the specified dimension member. Note: • • For better performance. SAP recommends that you always enter a connection name. once you have entered the function. Mandatory. dimension property cell Name of the dimension. the active connection is taken into account. Name of the connection. 251 2013-09-04 . stating that the description is ambiguous and recommending that you use the ID of the member instead.EPM Functions Parameter Description connection name Name of the connection. Name of the property for which you want to return the values. the dropdown list is displayed in the cell in which you have entered the function. provided that you are not connected to other models that have the exact same name. Mandatory. If not specified. Note: • If the description of a member exists in several dimensions. If not specified. Note: • • For better performance. Optional. the active connection is taken into account. Mandatory. 32. You also have the option to enter the name of a model instead of the connection name. provided that you are not connected to other models that have the exact same name. You also have the option to enter the name of a model instead of the connection name. Specify the cell in which the dropdown list containing all the values is displayed. a message appears. This is optional. This is optional. Parameter Description member connection name Member name. SAP recommends that you always enter a connection name. If not specified. The cell containing the EPMMemberOffset function increments members based on the member selected. a message appears. If the ID of a member exists in several dimensions. provided that you are not connected to other models that have the exact same name. 32. a message appears. Parameter Description connection name Name of the connection. Note: • • For better performance. By default. member property Note: • Member name. the active connection is taken into account. once you have entered the function. if the optional Level parameter is not included. • If the description of a member exists in several dimensions.14 EPMMemberProperty This function retrieves the value of a specified property for a specified member. 252 2013-09-04 . stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. SAP recommends that you always enter a connection name. You also have the option to enter the name of a model instead of the connection name. If not specified. once you have entered the function.15 EPMMemberOffset This function retrieves a member related to another member by specifying an offset from a given member to retrieve the previous or subsequent member.EPM Functions • If the ID of a member exists in several dimensions. Mandatory. 32. stating that the description is ambiguous and recommending that you use the ID of the member instead. This is optional. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. a message appears. the member at the same level as the member specified is incremented. once you have entered the function. Property name. Mandatory. and an increment of 2 returns 2009. Specify the number of member increments. You can use a negative offset. are displayed. stating that the description is ambiguous and recommending that you use the ID of the member instead. and so on. Specify the hierarchy level. Note: • • For better performance.Q2. an increment of 1 returns 2010. Mandatory. Optional."1") If cell D4 contains 2009. You also have the option to enter the name of a model instead of the connection name. If not specified. This is optional. 32. • If the description of a member exists in several dimensions. and no level is specified. provided that you are not connected to other models that have the exact same name. once you have entered the function. an increment of 1 returns the member 2009. Example: EPMMemberOffset("Finance". If cell D4 contains 2009. a message appears. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. Parameter Description connection name Name of the connection. If you specify a level that is below the member.EPM Functions Note: When you choose a specific level using the Level parameter. Mandatory. the level is ignored. member offset level Note: • Member to start from.TOTAL.TOTAL. a message appears.Q3. and no level is specified. the active connection is taken into account. once you have entered the function.Q1. If the ID of a member exists in several dimensions.16 EPMSelectMember 253 2013-09-04 .D4. note that only the members that are above the member (the one specified in the member parameter) or at the same level in the hierarchy. SAP recommends that you always enter a connection name. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). Description Parameter connection name Name of the connection. displaying all the members for the dimension. SAP recommends that you always enter a connection name. If you enter TRUE. When you double-click the cell containing the function. Mandatory. the active connection is taken into account. If not specified. Displays the same member name as the one displayed in the Context bar. Name of the dimension of the member for which you want to return the properties. 254 2013-09-04 . If you enter FALSE or do not specify anything. using the dimension properties. the ID of the member is displayed in the cell. Optional.EPM Functions This function retrieves a specified dimension member. You also have the option to enter the name of a model instead of the connection name. Optional. 32. You can select another member. The list of members can be optionally filtered. the double-click will not function. Filter by property to return only members with specified property values.17 EPMCellRanges This function defines dynamic cell ranges. member filter dimension context member name Member name. provided that you are not connected to other models that have the exact same name. This is optional. If the cell on which you double-click is merged with other cells. Note: • • For better performance. a dialog box opens. the member name that is displayed in the cell is the same member name as the one displayed in the Context bar. You also have the option to enter the name of a model instead of the connection name. to range26 Range of cell 32. Any member not specified is taken from the context. provided that you are not connected to other models that have the exact same name. the active connection is taken into account. the division is performed only on accounts that are scalable. the original amount is displayed in the cell. The data is divided by the number entered in the scale parameter and the result is displayed in the selected cell.18 EPMRefreshTime This function retrieves the time and date of the last data refesh for the specified connection. and scales the data.. 32. Parameter Description connection name Name of the connection. This is optional.19 EPMScaleData This function retrieves data for a full set of members. SAP recommends that you always enter a connection name.. If an account is not scalable. Note: • • For better performance. Note: You can view the "scaling" property of an account by selecting it in the sheet and then selecting EPM > More > Member Properties.EPM Functions Parameter Description range1. If not specified. 255 2013-09-04 . When using a Planning and Consolidation connection. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh orRefresh > Refresh Worksheet or Refresh > Refresh Workbook. to member24 Scale value. stating that the description is ambiguous and recommending that you use the ID of the member instead. based on a specified range of data drivers whose values you can modify. the active connection is taken into account. leave the other member parameters blank. you can specify to refresh a whole report that is outside of the specified range of data drivers. provided that you are not connected to other models that have the exact same name. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. You also have the option to enter the name of a model instead of the connection name.. 256 2013-09-04 . Note: • If the description of a member exists in several dimensions. SAP recommends that you always enter a connection name.20 EPMDriverBasedRefresh This function enables you to refresh specific rows or columns of one or more reports. scale member1. This is optional. Additionally. a message appears. a message appears. once you have entered the function. Or name of the context favorite.EPM Functions Parameter Description connection name Name of the connection.. Optional. If the ID of a member exists in several dimensions. 32. Mandatory. once you have entered the function. If you enter a context favorite in Member1. • • Name of the member. If not specified. This function can be used for example for what-if analysis. Note: • • For better performance. ID of one or more reports in the range. 32. meaning that all reports are taken into account): if you modify data in any cell of the column B. row 3 will be refreshed because B3 belongs to Report1. all the data in row 3 are refreshed. • However. When changing the data in B3 (cell belonging to the current report).EPM Functions Parameter Description range InRangeReportID OutOfRangeReportID ApplyToRow • Range containing the data drivers. to be refreshed. Note: the report specified must be in the same worksheet as the report in which data drivers are modified. you can specify the InRangeReportID parameter as follows: • You do not specify a report (and "" is displayed in the parameter area. • In the ApplyToRow parameter. to be refreshed. Report3 will be completely refreshed (members and data). Specify a report outside of the range. When modifying the EPMDriverBasedRefresh function. • Report3 is placed to the right of Report1 and has no row or column in common with Report1 and Report2. When modifying the EPMDriverBasedRefresh function. you specify column B because this column contains the data drivers. the corresponding row will be refreshed. When adding an EPMDriverBasedRefresh function: • In the range parameter. • Report2 is placed below Report1. You also want that Report3 be refreshed when there is a change in Report1 data drivers. • You specify the ID of Report1: if you modify the data in cell B3. enter TRUE. you can specify the ID of Report3. Report1 contains column B. Optional. 257 2013-09-04 . Report3 is linked to Report1 via an EPMDimensionOverride function. Data drivers are listed in column B. regardless of the report you are in.21 EPMRetrieveData This function retrieves data for a full set of members. Optional. if you modify the data in cell B11. to be refreshed. Any member not specified is taken from the context. row 11 will not be refreshed because B11 does not belong to Report1. ID of a report outside of the range. If the ID of a member exists in several dimensions. 32. If not specified. You also have the option to enter the name of a model instead of the connection name.. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. a message appears. 258 2013-09-04 . This is optional. stating that the description is ambiguous and recommending that you use the ID of the member instead. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead.EPM Functions Parameter Description connection name Name of the connection. to member25 Optional. provided that you are not connected to other models that have the exact same name. SAP recommends that you always enter a connection name. once you have entered the function. Note: • If the description of a member exists in several dimensions. • all the dimensions in one or more dropdown lists. • Or name of the context favorite. If you enter a context favorite in Member1. member1. leave the other member parameters blank. Note: • • For better performance.22 EPMDimensionList This function retrieves the list of all the dimensions of the model or cube for the specified connection. You can display: • all the dimensions in the current cell. where a specified character separates the dimension names. a message appears. • Name of the member.. once you have entered the function. the active connection is taken into account. you can perform a save. You can change the default setting in the Empty Comment area of the Others tab in the User Options. 259 2013-09-04 . Optional. Note: • • For better performance. the active connection is taken into account. 32.23 EPMSaveComment Applies to: Planning and Consolidation connections. SAP recommends that you always enter a connection name. the list separator from your local settings is applied. This function enables you to enter or modify a comment for a full set of members. range separator Specify one cell or a cell range if you want the dimensions to be listed in one or several dropdown lists. This is optional. Optional. You also have the option to enter the name of a model instead of the connection name.EPM Functions Parameter Description connection name Name of the connection.. Specify a separator if you want the dimensions to be displayed in the current cell. Any member not specified is taken from the context. in a specified cell.. using the Save Data button. If you do not specify a separator. the characters . The comment is saved to the server. If not specified. Note: If there is no comment for the specified members. are saved by default to the server. provided that you are not connected to other models that have the exact same name. Once you have entered or modified a comment. data from the database is displayed in both cells. SAP recommends that you always enter a connection name. The entered data is saved to the server. stating that the description is ambiguous and recommending that you use the ID of the member instead. the active connection is taken into account. for a full set of members. If the ID of a member exists in several dimensions. the data from the database is displayed. once you have entered the function. leave the other member parameters blank. If not specified. Then. member1. Note: • If the description of a member exists in several dimensions. provided that you are not connected to other models that have the exact same name.EPM Functions Parameter Description cell connection name Cell in which the comment is retrieved/entered. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. 32.. In the specified cell (first parameter of the function) and in the cell in which you entered the function. • • Name of the member. using the Save Data button. This is optional. You also have the option to enter the name of a model instead of the connection name. This function enables you to retrieve data from the database in a specified cell and to modify the data. perform a save. If you enter a context favorite in Member1.. When refreshing again. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. 260 2013-09-04 . once you have entered the function. Any member not specified is taken from the context. Note: • • For better performance. Once you have defined the function. a message appears. Or name of the context favorite. Mandatory. to member24 Optional. Name of the connection. Enter data in the specified cell. a message appears. refresh the worsheet.24 EPMSaveData Applies to: Planning and Consolidation connections. a message appears. member1. • Or name of the context favorite. stating that the description is ambiguous and recommending that you use the ID of the member instead. whereas the cell in which you entered data displays the latest data you entered. refresh the worksheet. If not specified. Note: • • For better performance. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. Then. a message appears. the data from the database is displayed. SAP recommends that you always enter a connection name. If the ID of a member exists in several dimensions.. the active connection is taken into account. the latest data that you have entered is displayed (the cell is empty if you have never entered any data). You also have the option to enter the name of a model instead of the connection name. Note: • If the description of a member exists in several dimensions. leave the other member parameters blank. Any member not specified is taken from the context. Once you have defined the function.25 EPMSaveDataOnly Applies to: Planning and Consolidation connections. This is optional. In the specified cell (first parameter of the function). 32. In the cell in which you entered the function. once you have entered the function.EPM Functions Parameter Description cell connection name Cell in which the data is retrieved from the database and in which you can modify the data. Enter data in the specified cell. using the Save Data button. Mandatory. The entered data is saved to the server. to member24 Optional. provided that you are not connected to other models that have the exact same name.. once you have entered the function. • Name of the member. Name of the connection. If you enter a context favorite in Member1. The cell in which you entered the function always displays the data from the database. in a specified cell. This function enables you to enter data for a full set of members. 261 2013-09-04 . stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. perform a save. . leave the other member parameters blank. to member24 Optional. You also have the option to enter the name of a model instead of the connection name. member1. the active connection is taken into account. SAP recommends that you always enter a connection name. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. a message appears. Mandatory. This function retrieves information about the work status. Name of the connection. If you enter a context favorite in Member1. a message appears. Note: • • For better performance. This is optional. 262 2013-09-04 . Or name of the context favorite.EPM Functions Parameter Description cell connection name Cell in which you enter data. once you have entered the function. once you have entered the function.26 EPMWorkStatus Applies to: Planning and Consolidation connections. If not specified. Note: • If the description of a member exists in several dimensions.. 32. If the ID of a member exists in several dimensions. • • Name of the member. provided that you are not connected to other models that have the exact same name. stating that the description is ambiguous and recommending that you use the ID of the member instead. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. once you have entered the function. stating that the description is ambiguous and recommending that you use the ID of the member instead. If the ID of a member exists in several dimensions. SAP recommends that you always enter a connection name. Mandatory. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh or Refresh > Refresh Worksheet or Refresh > Refresh Workbook. Or name of the context favorite. You also have the option to enter the name of a model instead of the connection name. a message appears. If you enter a context favorite in Member1. a message appears. 2=time. Optional.. 1=user. since the account type cannot be retrieved.to member24 Possible number values: 0=status.EPM Functions Parameter Description connection name Name of the connection. once you have entered the function. a simple subtraction is performed. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead.27 EPMComparison Applies to: Planning and Consolidation connections. If not specified. Note: • • For better performance. parameter member1. • • Name of the member. Performs a better or worse comparison of two values. leave the other member parameters blank. 32. provided that you are not connected to other models that have the exact same name. The account type property has the following values: • INC (Income) • EXP (Expense) • AST (Asset) • LEQ (Liabilities & Equity) 263 2013-09-04 . Note: • If the description of a member exists in several dimensions.. based on the account type property of the account member. the active connection is taken into account. This is optional. If you use this function on other connections. I. 32. This is optional. Mandatory. C. If the account is an expense account. F. account cell1 cell2 Note: • Name of the account member.C2). Example: EPMComparison("Finance". • If the description of a member exists in several dimensions. G. Mandatory. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. If cell B2 is greater than cell C2 and the account is a revenue (income) account. You also have the option to enter the name of a model instead of the connection name.28 EPMDimensionType Applies to: Planning and Consolidation connections. Cell reference of one of the values in the comparison. once you have entered the function. R. Mandatory. provided that you are not connected to other models that have the exact same name. once you have entered the function. a message appears."Revenue". • A for Account. The dimension types are: A. the variance is negative. Note: • • For better performance. the resulting variance is expressed as a positive. S. Cell reference of the other value in the comparison. • C for Category • D for Data Source • E for Entity • F for Measures • G for Ownership 264 2013-09-04 . This function retrieves a dimension depending on its type.EPM Functions Parameter Description connection name Name of the connection. SAP recommends that you always enter a connection name. D. a message appears. E. stating that the description is ambiguous and recommending that you use the ID of the member instead.B2. If the ID of a member exists in several dimensions. the active connection is taken into account. T and Un. If not specified. its context member is used instead. SAP recommends that you always enter a connection name. U3. dimensionType Type of the dimension. U1.29 EPMCommentFullContext Applies to: Planning and Consolidation connections.EPM Functions • • • • • I for Intercompany R for Currency-type dimension S for Subtable T for Time Un: each user defined dimension is assigned a numeric value after the U. U2. This is optional. provided that you are not connected to other models that have the exact same name. 32. You also have the option to enter the name of a model instead of the connection name. 265 2013-09-04 . Mandatory. Description Parameter connection name Name of the connection. Note: • • For better performance. the active connection is taken into account. and so on. If not specified. This function retrieves all comments associated to a set of dimension members that is fully defined. If there is no member specified for a dimension. Optional. provided that you are not connected to other models that have the exact same name. However. leave the other member parameters blank. Note: A comment is displayed by default in the cell in which you have entered the function. Note: • • For better performance. Any members not specified in the function is ignored. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh orRefresh > Refresh Worksheet or Refresh > Refresh Workbook. If the ID of a member exists in several dimensions. to member25 Member from which to retrieve associated comments. If not specified. you can use the Show as Microsoft Excel Comments option in the Sheet Options to display the comment as a standard Microsoft Office Excel comment.. Note: • If the description of a member exists in several dimensions. SAP recommends that you always enter a connection name. a message appears. This is optional. the active connection is taken into account. once you have entered the function. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. stating that the description is ambiguous and recommending that you use the ID of the member instead. a message appears. • Or name of the context favorite. This function retrieves all comments associated to a set of dimension members that is partially defined. 266 2013-09-04 . when you mouse over the cell.. member1. You also have the option to enter the name of a model instead of the connection name. If you enter a context favorite in Member1. • Name of the member.EPM Functions Parameter Description connection name Name of the connection.30 EPMCommentPartialContext Applies to: Planning and Consolidation connections. Related Topics • Show as Microsoft Excel Comments 32. once you have entered the function. you do not specify a member for the Time dimension. depending on the URL address you have specified. stating that the description is ambiguous and recommending that you use the ID of the member instead. a message appears. If not specified. Optional. You also have the option to enter the name of a model instead of the connection name.31 EPMURL This function retrieves a specified text on which you double-click to open in a browser a Planning and Consolidation web page or any other web page. then all comments entered for any period are returned. • If the description of a member exists in several dimensions. SAP recommends that you always enter a connection name. member1 . Note: • • For better performance. when you mouse over the cell. provided that you are not connected to other models that have the exact same name. Parameter Description connection name Name of the connection. Name of the member from which to retrieve associated comments. Entity and Time. once you have entered the function. a message appears. if your model contains the following dimensions: Account.EPM Functions For example. 267 2013-09-04 . • If the ID of a member exists in several dimensions. the active connection is taken into account. In the function. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. member25 Name of the member from which to retrieve associated comments. Note: • A comment is displayed by default in the cell in which you have entered the fonction. Optional. once you have entered the function. However you can use the Show as Microsoft Excel Comments option in the Sheet Options to display the comment as a standard Microsoft Office Excel comment. • This EPM function is executed when you refresh the worksheet or the workbook by selecting Refresh orRefresh > Refresh Worksheet or Refresh > Refresh Workbook.. Related Topics • Show as Microsoft Excel Comments 32.. This is optional. • To access a specific document. If not specified. right-click on the row of the document. Access a specific web page of Planning and Consolidation Applies to: Planning and Consolidation connections. Text in the cell on which to double-click. The web server is automatically added (even though not visible in the URL parameter). do as follows: in the Documents view. select the row of the object. the following text appears: "Navigate to". copy the text from the second column and paste it to the URL parameter of the EPMURL function.EPM Functions Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). • To access a specific web page of Planning and Consolidation (objects such as a web report or a specific view. If the cell on which you double-click is merged with other cells. a workspace or a Flash dashboard (designed with SAP BusinessObjects Dashboard Design). • To perform the following actions. enter the text corresponding to the page you want to open as the URL parameter. then select and copy the Direct Reference displayed at the bottom of the page and paste it in the URL parameter of the EPMURL function. copy the entire URL and paste it in the URL parameter of the EPMURL function. you must open the book from the Planning and Consolidation web client. then select Copy Direct Reference and perform a paste in the URL parameter of the EPMURL function. do as follows: in the Library view. or features such as opening the Documents view). or features such as opening the Documents view). 268 2013-09-04 . an input form. To access a specific web page of Planning and Consolidation (objects such as a web report or a specific view. • To access a specific web report. enter the text corresponding to the page you want to open as the URL parameter. Optional. The web server is automatically added (even though not visible in the URL parameter). • To access a specific book. Description Parameter URL displayedText Web address or specific text to a Planning and Consolidation web page. the double-click will not function. EPM Functions Action Text to insert as the URL parameter Create a web report Create an input form Create a workspace Open the Manage Comments tab Open the EPM add-in in Microsoft Excel Open the EPM add-in in Microsoft PowerPoint Open the EPM add-in in Microsoft Word Open the Administration view Open the Activities view Open the Process Monitor view Open the Library view Open the Documents view Open the Consolidation Monitor view Open the Controls view Open the Journals view action=createNewLiveReport action=createNewInputSchedule action=createNewWorkspace action=createCommentManager action=openXL action=openPP action=openWord action=openAdmin homePageFeature=MYACTIVITIES homePageFeature=PROCESSMONITOR homePageFeature=LIBRARY homePageFeature=DOCUMENTS homePageFeature=CONSOLIDATIONMONITOR homePageFeature=CONTROLS homePageFeature=JOURNALS 269 2013-09-04 . com 32. enter the full URL in the URL parameter. that is the location type that has been specified in the book publication template: • 2=Public • 3=Private • 4=Team. All the variable members that have been specified in the book publication template can be selected. do not use the locationType or teamID parameters. you must then specify the teamID parameter. • If the books you want to view have been published in several PDFs. If you specify the team location type. This function retrieves a specified text you can double-click to open a book published in Planning and Consolidation web client. you must specify the locationType parameter. connections. homePageFeature=OWNERSHIPMANAGER homePageFeature=AUDIT homePageFeature=ANALYSIS Open another web page To open another web page that is not related to Planning and Consolidation.32 EPMBook Applies to: Planning and Consolidation connections. 270 2013-09-04 . displaying the book specified. the double-click will not function. For example: http://google. version for the Microsoft platform. a web browser opens. If the cell on which you double-click is merged with other cells. The data on the right part of the window is updated accordingly. When you double-click the cell. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options).EPM Functions Action Text to insert as the URL parameter Open the Ownership Manager view Open the Audit view Open the Analysis view Applies to: Planning and Consolidation. using the dropdown lists to the left part of the window. • If the books you want to view have been published in one single PDF. Name of the section. stating that the description is ambiguous and recommending that you use the ID of the member instead. a message appears. Name of the book publication template. • Name of the member. • Or name of the context favorite. If not specified. the specified file opens and the context is passed along. If you want to override certain context members. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). (only for single PDF) Specify the location where the PDF has been published. the following text appears: "View [template name]".33 EPMLink This function displays a specified text on which you double-click to open a Microsoft Excel workbook. once you have entered the function. Optional. Optional. If you enter a context favorite in Member1. 3=Private. • 32. 271 2013-09-04 . 2=Public. If the ID of a member exists in several dimensions.EPM Functions Parameter Description modelName templateName sectionName locationType teamID displayedText member1. leave the other member parameters blank. Text in the cell on which to double-click. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead.. once you have entered the function. you can optionally specify other members. If the cell on which you double-click is merged with other cells. If not specified. Specify the name of the variable member. to member19 Name of the model. When you double-click the link. the double-click will not function.. 4=Team (only for single PDF and for Team location) Specify the ID of the team for which the PDF has been published. Note: • If the description of a member exists in several dimensions. a message appears. the model for the active connection is taken into account. if the file is not found in the Planning and Consolidation server. once you have entered the function. Note: This path is different from the path for the EPMPathLink function. see EPMPathLink.. • Name of the member. a message appears. Optional. • 32. This is optional. • Or name of the context favorite. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. Also. once you have entered the function. the active connection is taken into account. to member23 Text in the cell to double-click on. However. Optional. If the ID of a member exists in several dimensions. Also.. enter the path you want and the file to open. provided that you are not connected to other models that have the exact same name. make sure the Local option is selected in the Others tab of the User Options. If you enter a context favorite in Member1. If not specified. Members that override the context members. Note: • If the description of a member exists in several dimensions. make sure the Planning and Consolidation option is selected in the Others tab of the User Options. You also have the option to enter the name of a model instead of the connection name. file • • displayedText member1. leave the other member parameters blank.34 EPMPathLink 272 2013-09-04 . Note: • • For better performance. If you use a local connection.EPM Functions Parameter Description connection name Name of the connection. If you use a Planning and Consolidation connection. keeping in mind that it is automatically searched for at the following location: \WEBEXCEL\TEMPLATELIBRARY\REPORTS\WIZARD\. a message appears. SAP recommends that you always enter a connection name. For more information. the file is searched for in local folders. stating that the description is ambiguous and recommending that you use the ID of the member instead. enter a path and a file to the server. • Name of the member. leave the other member parameters blank. a message appears. Note: • • For better performance. stating that the description is ambiguous and recommending that you use the ID of the member instead. Also. see EPMLink. enter a path and a file to the server. SAP recommends that you always enter a connection name. to member23 Text in the cell to double-click on. You also have the option to enter the name of a model instead of the connection name. the active connection is taken into account. If you use a local connection. once you have entered the function. keeping in mind that it is automatically searched for at the following location: \WEBEXCEL\TEMPLATELIBRARY\.EPM Functions This function retrieves a specified text on which you double-click to open a Microsoft Excel workbook.. This is optional.. make sure the Local option is selected in the Others tab of the User Options. For more information. • Or name of the context favorite. Note: • If the description of a member exists in several dimensions. provided that you are not connected to other models that have the exact same name. 273 2013-09-04 . Note: This path is different from the path for the EPMLink function. Optional. If the cell on which you double-click is merged with other cells. make sure the Planning and Consolidation option is selected in the Others tab of the User Options. Also. you can optionally specify other members. When you double-click the link. If you enter a context favorite in Member1. Description Parameter connection name Name of the connection. If you use a Planning and Consolidation connection. the file is searched for in local folders. the double-click will not function. However. if the file is not found in the Planning and Consolidation server. If you want to override certain context members. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). the specified file opens and the context is retrieved. enter the path you want and the file to open. Members that override the context members. file • • displayedText member1. Optional. If not specified. Optional. Optional. the double-click will not function. 1=type. endDate sortField 274 2013-09-04 . Optional. a message appears. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). 0=title. Criteria on which you want to sort the documents. the system returns all document types. the model for the active connection is taken into account. 2=sub-type. The format must be the one that is selected in your local settings. the system returns all document subtypes. The format must be the one that is selected in your local settings. If left blank. Optional. For example: mm-dd-yyyy. 32.EPM Functions • If the ID of a member exists in several dimensions. This function opens the Planning and Consolidation Documents view and retrieves a filtered list of documents. The sub-type assigned to the documents. stating that the ID is ambiguous and recommending that you use the full unique name of the member instead. For example: mmdd-yyyy. 3=model. 4=date. The description of the document.35 EPMDocumentList Applies to: Planning and Consolidation connections. once you have entered the function. Description Parameter modelName docType docSubType docDescription startDate Name of the model. If not specified. The document type assigned to the documents. An ending date to which to search the Documents list for the document. If the cell on which you double-click is merged with other cells. You can then double-click a document in the list to open it. A starting date from which to search the Documents list for the document. If left blank. "1"=new tab in the same window. Three possible values: "0"=same tab (default). the model for the active connection is taken into account. "1"=new tab in the same window. If not specified. Where in the web browser to display the document. Name of the file to open. 1=descending. Optional. "2"=new window.EPM Functions Parameter Description sortOrder targetWindow displayedText Sorting order.37 EPMCellContextDocument 275 2013-09-04 . Optional. Optional. Where in the web browser to display a document. "2"=new window. If not specified. If not specified. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). Optional. Description Parameter modelName docName team docType targetWindow Name of the model. This function retrieves a specified text you can double-click to open a document strored on the Planning and Consolidation Documents view. Optional. Three possible values: "0"=same tab (default).36 EPMDocument Applies to: Planning and Consolidation connections. displayedText 32. Optional. the double-click will not function. the following text appears: "View Documents". The document opens in a web browser. Text in the cell to double-click on. the following text appears: "View [name of the document]". The document type assigned to the document. Team that has access to this document. 32. If the cell on which you double-click is merged with other cells. 0=ascending. Text in the cell to double-click on. Optional. 276 2013-09-04 . Note: The APIs are available in the IEPMExecuteAPI class. When several parameters. Parameter Description APIname DisplayedText Parameter Name of the API. Mandatory. the double-click will not function. This function enables you to upload or view a web document for a combination of members specified by a cell you double-click in. member1 .EPM Functions Applies to: Planning and Consolidation connections. Enter 2 to open the window that enables you to view the document. Specify the text the user selects to execute the API. cell display name dimension1 . Name of the dimension that you want to override. ber5 32. Description Parameter action name Enter 1 to open the window that enables you to upload the document. mem.. Note: • • Make sure that double-click actions are enabled (the Enable Double-Click option must be selected in EPM > Options > User Options). use the list separator that is specified in your local settings. the report members and the connection. When clicking the cell in which you insert the function. the API is executed..38 EPMExecuteAPI This function enables you to execute APIs directly from a worksheet cell. API parameter name. If the cell on which you double-click is merged with other cells. Mandatory (if the API has parameters).Name of the member that you want to override. dimension5 Specify the cell for which you want to upload or view a web document. Specify the text in the cell to double-click on. By selecting a cell. The document can be used as a comment attached to a combination of members. you are specifying the context... EPM Functions Related Topics • APIs 277 2013-09-04 . EPM Functions 278 2013-09-04 Data Input and Save Data Input and Save Applies to: Planning and Consolidation connections. Following is the workflow for the overall data input and save feature, provided that the appropriate task profiles are assigned to you: • Enter data in an input form. You can use planning features to help you enter your data. Note: A report is called an input form when you can both enter data in it and save it to the server. • Add comments to the data. Note: You can add comments using the EPM add-in in Microsoft Office Excel, Word or PowerPoint. • • • Save the data entered. The data is written in the database. Validate data. This is only available in Planning and Consolidation, version for the Microsoft platform, connection. Change the work status so that you can lock a specific data region. Note: Task profiles are assigned in the Administration section of Planning and Consolidation. 33.1 Data Input Applies to: Planning and Consolidation connections. There are two ways of entering data: • Enter data directly in the cells of an input form. Note: To help you enter your data in an input form, you can: • Use planning features. For more information, see Planning Features. • Use the Keep Formula on Data option. For more information, see Keep Formula on Data and Show Source Data in Comments . • Perform a sum on each parent in the hierarchies. For more information, see Calculate Parents in Hierarchies. 279 2013-09-04 Data Input and Save • • Insert members that are not displayed in the input form. For more information about how to insert members, see Member Entry Using the Insert Members Dialog Box Enter data for a fully specified data region, using the EPMSaveData function. For more information, see EPMSaveData. You can save the data you enter in an input form only if you meet the following criteria: • You can enter data for a fully specified data region where each member - for each dimension of the model - is an inputable member, meaning a base level member (or not a calculated member). Tip: To quickly and easily view for which members you can enter data, use the dynamic formatting sheet, select the Dimension Member/Property Formatting section, define a specific format in the Inputable Member Default Format row and perform a refresh on your input form worksheet. For more information, see Dynamic Formatting Template Definition. Note: To find out if a member is inputable or not, you can also select a member in your input form and select More > Member Properties. In the "CALC" property, "Y" indicates that the member is calculated and therefore not inputable; "N" indicates that the member is a base level member and is therefore inputable. • You can enter data if you have been granted the appropriate profiles in the Administration view of Planning and Consolidation. Related Topics • Member Properties 33.2 Planning Features Applies to: Planning and Consolidation connections. You can use planning features to help you enter your data in an input form. You can use the following planning features: • Spread. The spread feature enables you to take a value and allocate it among selected destination cells. • Trend. The trend feature takes a value or percentage and grows it by a factor among selected cells. This option places the source value in the first cell of the destination range. Each subsequent cell in the destination increases by the amount or percentage specified. • Weight. The weight feature lets you allocate a set of values by weighted factors in your spreadsheet. • Disaggregation. 280 2013-09-04 Data Input and Save 33.2.1 Spread Applies to: Planning and Consolidation connections. The spread feature enables you to take a value and allocate it among selected destination cells. The value can be allocated equally, or it can be weighted by a range of values. For example, you can take the value 100,000 and spread it across a number of columns that represent each month of the year. To perform a spread, selectPlanning > Spread and specify the following items in the Spread dialog box: • Source Value. Specify the total value to be spread. • Destination. Specify the destination cells in which the system writes the results of the spread. • Weights. This is optional. Specify a range containing weight values upon which to base the spread. This range must contain the same number of cells as the destination range. The source value is spread based on the selected weights. If you do not specify weights, the source value is spread evenly. • Select one of the Spread Result options: • • To take the spread amount to each cell and add it to any existing values already in the destination range, select the Add to Existing Values option. So that the amount spread to each cell overwrites the amounts in the destination cells, select the Overwrite Existing Values option. 33.2.2 Trend Applies to: Planning and Consolidation connections. The trend feature takes a value or percentage and grows it by a factor among selected cells. This feature places the source value in the first cell of the destination range. Each subsequent cell in the destination increases by the amount or percentage specified. To perform a trend, selectPlanning > Trend and specify the following items in the Trend dialog box: • • Source Value. Specify the initial value from which the trend begins. Specify a value or a percentage: • By Percentage: Specify a percentage of the previous value (previous cell) in the destination range. To create an increasing trend, use a positive percentage. To create a declining trend, use a negative percentage. 281 2013-09-04 Data Input and Save • By Value: Specify an amount over the previous value (previous cell) in the destination range. To create an increasing trend, enter a positive value. To create a declining trend, enter a negative value. • • • Destination. Specify the destination cells in which the system writes the results of the trend. Weights. This is optional. Specify a range containing weight values upon which to base the spread. This range must contain the same number of cells as the destination range. The source value is spread based on the selected weights. If you do not specify weights, the source value is spread evenly. Select one of the Trend Result options: • • To take the trend amount to each cell and add it to any existing values already in the destination range, select the Add to Existing Values option. To ensure that the amount trend to each cell overwrites the amounts in the destination cells, select the Overwrite Existing Values option. 33.2.3 Weight Applies to: Planning and Consolidation connections. The weight feature lets you allocate a set of values by weighted factors in your spreadsheet. It enables you to take a set of values, grow them if desired, and then allocate the new amount based on the relative weights of the selected cells. The destination range is the same as the weight range. For example, you can weigh 12 months of revenue based on 12 months of cost of sales. To perform a weight, select Planning > Weight and specify the following items in the Weight dialog box: • Sum to allocate. Specify the initial sum from which the allocation begins. This amount defaults to the sum of the selected cells. • Specify a value or a percentage: • By Percentage: Specify a percentage so that the sum to allocate is increased by the specified percentage before allocating. • By Value: Specify an amount so that the sum to allocate is increased by the specified value before allocating. • None. Select this option so that the sum to allocate remains unchanged before allocating. • Destination. Specify a range of cells that contain relative weights, to which the results of the allocation are written. 33.2.4 Data Disaggregation 282 2013-09-04 Data Input and Save Applies to: Planning and Consolidation, version for SAP NetWeaver connections, when SAP HANA is used as the relational data base. Provided that the data disaggregation feature is activated on the server side, you can disaggregate data. Data disaggregation can be performed on aggregated values, that is nodes: the values are disaggregated to all the data records of the base-level members that contribute to the aggregated value of the cell. To disaggregate data for a node, in the report, select the cell that contains the data you want disaggregate. Then, select Planning > Disaggregate. Note: If you have not selected a data cell or if the data cell does not contain any data, a message is displayed, indicating that data disaggregation cannot be performed from the cell you have selected. Caution: When you perform data disaggregation, the data is automatically saved to the sever. A message that warns you about this, is displayed when you select Planning > Disaggregate. If you do not want to display this warning message anymore, you can either select the Do not show this message again option in the message box or deselect the Display Disaggregation Warning option in the User Options. These two options are synchronized, meaning that when the first one in the message box is checked, the user option is automatically unchecked. There are three ways of disaggregating data: • Equal Method: the total value of the node is distributed equally to the base-level members. Example: In the report below, the sum of the months Jan, Feb and March is 90. You use the equal method to disaggregate 90. As a result, Jan, Feb and Mar contains 30 (90/3=30). Quarter 1 Germany • 90 Jan 10 Feb 30 Mar 50 Proportional Method: the total value of the node is distributed to the base-level members proportionally to their existing values. Example: In the report below, the sum of the months Jan, Feb and March is 100, with the value in Jan accounting for 10% of the sum, the value in Feb accounting for 30%, and the value in Mar accounting for 60%. Quarter 1 Germany 100 Jan 10 Feb 30 Mar 60 You enter 300 in Quarter 1. You use the proportional method to disaggregate 300. 283 2013-09-04 Data Input and Save Quarter 1 Germany 300 Jan 30 Feb 90 Mar 180 As a result, Jan contains 30, which is 10% of 300; Feb contains 90, which is 30% of 300; Mar contains 180, which is 60% of 300. • Relative Proportional Method: the total value is distributed to the base-level members proportionally to the selected member value. When selecting this method, you then select a dimension from the dropdown list, then click the ellipsis button and select a member from the Member Selector that opens. Note: You can only select one member. Alternatively, you can select a member from the dropdown list that displays the last five members that you selected for the selected dimension and report. Example: In the report below, for Germany/Quarter 1, the sum of the months Jan, Feb and March is 100, with the value in Jan accounting for 10% of the sum, the value in Feb accounting for 20%, and the value in Mar accounting for 70%. Quarter 1 France Germany 0 100 Jan 0 10 Feb 0 20 Mar 0 70 You enter 400 for France / Quarter 1. Using the relative proportional method to disaggregate 400, you select the Germany member. Quarter 1 France Germany 400 100 Jan 40 10 Feb 80 20 Mar 280 70 As a result for France, Jan contains 40, which is 10% of 400; Feb contains 80, which is 20% of 400; Mar contains 280, which is 70% of 400. When you have finished specifying the disaggregation, click the Save button. The data is saved to the server. 33.3 Comments 284 2013-09-04 Data Input and Save Applies to: Planning and Consolidation connections. Comments provide a vehicle for submitting, storing, and retrieving text commentary associated with report data cells. This allows users to annotate data so other users can view supporting information associated with a particular data point. You can perform the following actions on comments, using the EPM add-in: • Add or modify a comment to a specific data region. • Retrieve a comment in a cell, for a specific data region. • Search for comments that meet specific criteria. Note: • • You can also view a history of the comments and delete comments, in the web client of Planning and Consolidation. You can add or search for comments using the EPM add-in in Microsoft Office Excel, Word or PowerPoint. 33.3.1 Comment Creation and Modification Applies to: Planning and Consolidation connections. Note: When using a Planning and Consolidation, version for the NetWeaver platform, connection, to add or modify a comment, the option enabling comment creation in the Administration view must be selected. There are two ways of adding a comment: Add a comment using the dedicated dialog box You can add a comment, using a dedicated dialog box. Select Comments > Add Comment and specify the following items in the Add Comment dialog box: • • • Select the desired priority level. The reports show comments in order of their priority level. Enter your comment. A comment is limited to 512 characters. Enter one or more keywords to organize and search for comments in the database. Do not use special characters for the keywords. The separator character used to separate the keywords is the comma. • Select to which of the following you want to associate the comment: • The active cell. The comment is applied to the data region associated with the selected cell. • The current context. The comment is applied to the context displayed in the EPM Context bar. • A context favorite. The comment is applied to the context specified in the context favorite. For more information on context favorites, see Context Favorites. 285 2013-09-04 Data Input and Save • A custom context. This option allows you to specify a different context than the current one, to which to associate the comment. For each dimension, select: a member or none of the members. If you select None, the comment applies to any member for that dimension. When you click Save in the Add Comment dialog box, unless there is an error, the comment is saved to the server. Note: If you want the save result to be displayed, select the Display Warning when Saving Data or Comment option in the User Options. If the option is selected, as soon as you click Save in the Add Comment dialog box, a message appears, informing you whether or not the comment has been saved. Add or modify a comment using the EPMSaveComment function You can add or modify a comment for a full set of members, using the EPMSaveComment function. For more information, see EPMSaveComment. Note: If comments have already been entered on a combination of members, entering a comment on the same combination of members does not overwrite the previous comments. You can view a history of the comments in the web client of Planning and Consolidation. Modify a comment using the Excel standard tooltips If you have selectedSheet Options > General > Show as Microsoft Excel Comments, comments are displayed as standard Microsoft Office Excel comments, which are in tooltips that appear when you mouse over the cells. For more information, see Show as Microsoft Excel Comments. You can modify a comment directly in a tooltip and save it locally when saving your workbook. Note: Even if the worksheet is protected, if you select Edit Objects in the Protection tab of the Sheet Options, you can still modify the comments directly in the tooltips. Related Topics • Worksheet Protection 33.3.2 Comment Display in a Cell Applies to: Planning and Consolidation connections. You can retrieve comments in cells for specific combinations of members, using the following EPM functions: • EPMCommentFullContext. For more information, see EPMCommentFullContext. • EPMCommentPartialContext. For more information, see EPMCommentPartialContext. 286 2013-09-04 • Myself. select Sheet Options > General > Show as Microsoft Excel Comments. Returns comments associated with the context defined in the context favorite. see Context Favorites. This option returns comments entered by all users. if several comments have been entered on the combination of members specified in either one of the EPM functions. • Related Topics • EPMCommentFullContext • EPMCommentPartialContext • Show as Microsoft Excel Comments 33. To select the users. This option returns comments that you have entered. • Specific Users. select: a member or all members. Returns comments associated with the members for the active cell. use the comma as the separator character. Select Comments > Find Comments and specify the following search items in the Find Comments dialog box: • Enter one or more keywords to return only comments with matching keywords. Use the From and To dropdown lists to specify the desired date range and select the checkboxes. the latest comment entered is displayed. Specify a date range for which to return comments. You can only enter the beginning of a keyword and the search is performed on all keywords beginning with what you entered. If you display the comment as a standard Microsoft Office Excel comment (displayed when you mouse over the cell). Returns comments associated with the active context. • The current context. Select which of the following is associated to the comments you are searching for: • The active cell. If you enter more than one keyword. • • Select one or more priority options to return comments associated with that priority. For each dimension. Returns comments associated with a different context than the current one. • A context favorite.3.Data Input and Save Note: • The comment is displayed by default in the cell in which you have entered the function. For more information on context favorites. click the ellipsis button. • • 287 2013-09-04 . • A custom context. This option returns comments entered by one or more users. You can retrieve comments that meet specific criteria. Specify the author of the comment: • Anyone.3 Comment Search Applies to: Planning and Consolidation connections. everything that is in the current worksheet is refreshed: the data of the reports.Data Input and Save When you click Find. use the Save Data command in the EPM tab of the ribbon. For example: you enter data for January. • If the option Refresh only Data on "Save & Refresh Data" is selected in the User Options. the data of the EPM functions. 288 2013-09-04 . To write data to the server. then data is refreshed in your input form. everything that is in the current workbook is refreshed: the data of the reports. all the reports (including local member data. 33. February and March.4 Data Save Applies to: Planning and Consolidation connections. In the save data confirmation message. • If the option Refresh only Data on "Save & Refresh Data" is not selected in the User Options. If the option Refresh only Data on "Save & Refresh Data" is selected in the User Options. You select EPM > Save Data > Save and Refresh Worksheet Data. Note: If you do not want to send the parent data to the server. the list of comments found is displayed in the web client of Planning and Consolidation that opens. and so on). the sum of the three months you have entered is displayed for Quarter 1 in the input form. taking into account the data you have saved and recalculating the amounts accordingly. formatting. • Save data entered on the current workbook and then perform a refresh. not everything that is in the current workbook is refreshed but only the data for all EPM functions and all the reports (except the data for local members) in the current worksheet is refreshed. unselect the user option Send Parent Data to the Server on "Save Data". • Note: The Save and Refresh Worksheet Data is the default save action when you directly click the Save Data button. As the data form is refreshed from the server. then data is refreshed in your input form. only the data for all EPM functions and all the reports (except the data for local members) in the worksheet is refreshed. Data is first saved to the server. • Save the data entered in the current workbook. formatting. • Save the data entered in the current worksheet and then perform a refresh. By default. the data of the EPM functions. and so on). all the reports (including local member data. taking into account the data you have saved and recalculating the amounts accordingly. • If the option Refresh only Data on "Save & Refresh Data" is not selected in the User Options. Data is first saved to the server. this option is selected and all data are sent to the server. only the number of base member data will be displayed. You can perform the following save-related actions: • Save the data entered in the current worksheet. you must perform the following actions: • Create a workbook (the validation report) and save it to one of the following locations on the server: Input Schedules or Input Schedules/Wizard • In the Planning and Consolidation Administration. a dialog box opens. Note: If you cannot save data. a message appears. For more information. select the Display Warning when Saving Data or Comment option in the User Options. informing you if the data has been saved or not. Once you have entered and saved data. For more information. see Read-only Data. you can launch a data validation. enter the name of the workbook as the value of the LOCKREPORT parameter. on the data region. connections. Related Topics • EPMSaveData • EPMSaveComment • User Options 33. select Save Data > Validate Data. version for the Microsoft platform. When launching a data validation. the system checks to make sure there are no work status locks or validity issues.Data Input and Save Either of the above save actions writes to the server all the following records that have been changed on the current worksheet or workbook: • Data. If the option is selected. as soon as you perform a data save. The validity check consists in checking that the Validation account equals 0. you can choose not to save the data entered on specific members. Before launching a data validation. 289 2013-09-04 . the message says so). if you confirm.5 Data Validation Applies to: Planning and Consolidation. Note: If you want the save-related messages to be displayed. whether the data has been entered directly in cells or by using the EPMSaveData function. To validate data. • Comments that have been entered using the EPMSaveComment function. respectively. check that your administrator has granted you the appropriate rights and make sure that the Use as Input Form is selected in the current report options. see Use as Input Form. prompting you to confirm if you want to save x data (if there is no data to save. For a specific input form. For example. you can change the work status. When the data is validated. If you are working with Planning and Consolidation. you can set the work status to "Saved". after saving data. 290 2013-09-04 . save it and revalidate it. Note: The work statuses that are available for selection have been defined in the Administration view. which is defined as the owner dimension in the Administration view. selectSave Data > Change Work Status. • • • In the New Work Status area. you can include in the selection all the descendant members of the specified member by selecting the Include all Descendants option. The work status feature enables you to apply a label to a data region and lock it for review.Data Input and Save If the data does not pass the validation. Once you have entered and saved data. You can select a work status that reflects the state of data. Note: The work status is set up in the Administration view. You can then modify the data accordingly. you must only select a base member for each dimension or you will not be able select another work status. 33. and so on. To change the work status for a data region. the context member is displayed by default. • In the Change Status for area. Note: • For the first dimension. you define for which data region you want to change the work status. From three to five dimensions are available.6 Work Status Applies to: Planning and Consolidation connections. you can modify the work status for a specific data region. a message appears and prompts you to run and open the validation report that will show you what is incorrect. You can change the work status only for members of which you are the owner or manager. For each dimension. approval. This locks the data region from being overwritten. the current status for the specified data region is displayed. The Change Work Status dialog box opens. This is defined in the Administration view. You can select another member for a dimension by clicking the ellipsis button. for SAP NetWeaver. Accessing Journals Accessing Journals Applies to: Planning and Consolidation connections. From the EPM tab in Microsoft Office Excel. and the context for the model to which you are connected is retrieved. 291 2013-09-04 . see the SAP BusinessObjects Planning and Consolidation help. This is typically done as part of the month-end or quarter-end process. you can access the Journals view of SAP BusinessObjects Planning and Consolidation by clicking Journals. Planning and Consolidation opens in a web browser. For more information. You use journals to record and make adjustments to data in the database. displaying the Journals view. Accessing Journals 292 2013-09-04 . When you click a sub-action link. When you are finished performing all the actions. Word or Powerpoint is already opened. When you click an action. In the Planning and Consolidation web client. it takes you to the place where you can perform the action. Note: If Microsoft Excel. It is the same for Microsoft Office Word and Microsoft Office PowerPoint when the actions must be performed in these applications. 293 2013-09-04 . and the dedicated Process tab is displayed in the EPM pane. A Business Process Flow is set up for a specific environment in Planning and Consolidation. when you click an activity or process covering actions that are to be performed using the EPM add-in in Microsoft Office Excel. the sub-actions that are related to the action are displayed below the list of actions. Business Process Flows guide you through a sequence of tasks within a defined business process. A list of actions is available. a new instance of the application opens.Business Process Flows Business Process Flows Applies to: Planning and Consolidation connections. click the button at the bottom of the tab to go back to Planning and Consolidation. the application opens. Business Process Flows 294 2013-09-04 . Report and Input Form Templates Report and Input Form Templates Applies to: Planning and Consolidation connections. • Templates for reports are stored in the "Templates" of the "Reports" folder. • No template designed for input forms. • For the "Finance" model: • 10 templates designed for reports. In the "Shell" environment. Related Topics • Do not Store Connection and Do not Store Environment in the Connection 295 2013-09-04 . • For the "Rate" model: • 4 templates designed for reports. then change the context members and the dynamic template continues to be valid. • 5 templates designed for input forms. • 3 templates designed for input forms. • You can find the templates in the following folders on the Planning and Consolidation server: • Templates for input forms are stored in the "Templates" folder of the "Input Schedules" folder. For the "Ownership" model: • 2 templates designed for reports. Note: Since a template can be used with various connections. the Do not Store Connection option in EPM > Edit Report > Options is selected by default. Each workbook contains two worksheets: • One sheet contains the template: you can connect the template to any model. • One sheet contains a dynamic formatting sheet that is applied to the template. dynamic templates are available within Microsoft Office Excel workbooks. Report and Input Form Templates 296 2013-09-04 . all the local structure files are deleted and all the files of the structure of the data source are loaded locally. • You can define the frequency at which the cache is automatically cleared.1 Metadata Cache The metadata cache behavior is different.Other Features Other Features 37. depending on the types of connections. You can clear the metadata cache. Select EPM > User Options. 297 2013-09-04 . the cache is cleared once a day. • You can clear the cache whenever you want. select EPM > More > Clear Metadata Cache. modified or deleted in the data source are loaded. When the cache is cleared. select EPM > User Options. when editing and creating a connection. then select the Clear Metadata Cache Frequency option and enter a number in the field. You can clear the metadata cache. If you enter 1. which means that the members of dimensions that have been added. The metadata cache feature is not activated by default. then select the Activate Metadata Cache option. the structure of the data source you are connected to is synchronized with the structure copied locally. The metadata cache feature is always activated for Planning and Consolidation connections. To activate the cache. Each time you connect to a data source. Select EPM > More > Clear Metadata Cache or click the Clear Metadata Cache button in the Edit Connection and Create Connection dialog boxes. meaning that the dimensions and members are loaded each time you connect to a data source. meaning that the metadata is copied locally and not loaded each time you connect to a data source. Using the cache enables you to improve the connection time. You can activate the cache. When the cache is cleared. Metadata Cache for Local and SAP BusinessObjects Enterprise Connections Applies to: Local and SAP BusinessObjects Enterprise connections. Metadata Cache for Planning and Consolidation Connections Applies to: Planning and Consolidation connections. To do so. the structure of the data source you are connected to is synchronized with the structure copied locally. The name of the database. The last time the cube was deployed. The content of the log depends on what has been defined in the configuration file. For more information. select a report that is connected to the cube for which you want to see information and selectEPM > More > Cube Information. 298 2013-09-04 . The log files are stored locally at the following default location.Excel. see the SAP BusinessObjects EPM Solutions. To view the information on a cube.log. 37.dll.3 Information on Cubes Applies to: Financial Consolidation SSAS cubes. select EPM > More > Log.log. Only the last 100 rows of the log files are displayed in this screen. Note: This location is displayed in the Log screen.Other Features 37. To view the log. You can view all the log rows in the following log files: • FPMXLClient. • FPMXLClient. add-in for Microsoft Office Installation guide.dll. enter: %temp%/log. the log file contains the errors for any use of the EPM add-in and all types of information related to the Planning and Consolidation EvDRE migration. You can display the following information on a cube: • • • • The name of the cube.2 Log File The log can contain three types of information.Migration. including Planning and Consolidation EvDRE migration information: • Infos • Errors • Warnings Note: • • By default. This log file contains all the information related to the EvDRE migration. In your file explorer. The last time the cube was processed. select EPM > More > Display MDX.Other Features 37. You can then copy the MDX query and reuse it. To display the MDX query. 299 2013-09-04 .4 MDX Display Applies to: Local and SAP BusinessObjects Enterprise connections. You can display the MDX query for the current data sheet. Other Features 300 2013-09-04 . • • • • • • • • • • • Several reports in a document or presentation. Word and PowerPoint. You can create a report using the Report Editor and the EPM pane. Log. These features behave just as they do in the add-in for Microsoft Office Excel. 38. You can also copy and paste reports. Cube information. See Open and Save a File. Therefore. 301 2013-09-04 . • The list of options available for the add-in for Microsoft Office Word and PowerPoint. • Open and Save actions. See Going Back in the Navigation Actions. to read more about the features. follow the links. Comment creation and search. See Report Creation . Report refresh.EPM Add-in for Microsoft Office Word and PowerPoint EPM Add-in for Microsoft Office Word and PowerPoint In this section. See Information on Cubes . • Report creation and member selection. See Flash Object Insertion. • Features that are specific to the add-in for Microsoft Office Word and PowerPoint. you will find: • A list of the features that are common to the add-in for Microsoft Office Excel. See Several Reports in a Sheet . See Custom Members. See Logon and Connections. See Metadata Cache. Clear metadata cache. you can perform the actions listed below. See Report Refresh . Custom members. Flash object insertion. See Comments. You can refresh the selected report or all the reports in the entire file. using the dialog boxes that open when selectingEPM > Comments > Add Comment or Find Comments. Back command. You can select dimension members in the Member Selector dialog box. See Log File. See Report Publication to a Web Portal. See MDX Display. Word and PowerPoint Using the add-in for Microsoft Office Word and in Microsoft Office PowerPoint. Note: Asymmetric reports are not supported in Microsoft Office Word and in Microsoft Office PowerPoint. Display MDX.1 Common Features to the Add-in for Microsoft Office Excel. • Logon and connections. Publication on a portal. EPM Add-in for Microsoft Office Word and PowerPoint 38. You can change the selection by clicking a member or the context favorite. You can click on it and change the dimension and the member name to display. When you select the data in the document or presentation. the dimensions and members selected or the context favorite name are displayed in the EPM pane. then a member for the dimension. etc). you cannot insert data or insert a context member in the following types of object: table and shape. using the dropdown list. • for a specified set of dimension members. then Context. • When you select the context member name in the document or presentation. • To insert data for a context favorite. Description. • To insert data for other members. select a dimension. the context members are taken into account for the unspecified dimensions. then select Context Favorite and select the context favorite from the dropdown list. Restriction: In Microsoft Office Word. the member name that is applied is the one that is currently used in the context bar. using the dropdown list. select the dimension. select Insert > Insert Data from the EPM tab in the ribbon. select the dimension. To insert data. select Context Favorite and select the favorite from the list. you can perform the following actions: • insert data (one value): • for the context dimension members. The Insert Data dialog box opens. then click OK. • To insert the current context member of a dimension. 302 2013-09-04 . select Insert > Insert Context Member from the EPM tab in the ribbon. Then select the other dimensions and their context member and click OK.2 Additional Features in the Add-in for Microsoft Office Word and PowerPoint Additionally. The Insert Context Member dialog box opens. • To insert data for the current context dimension members. • for a context favorite. select a dimension. Then select the other dimensions and other members. then click OK. • insert a context member: To insert the context member for a specific dimension. then select Current Context. Description. By default. If you do not specify a member for all the dimensions of the cube or model. the context member is displayed in the EPM pane. You can then select the member name you want to display in the document or presentation (ID. You can then select the member name you want to display in the document or presentation (ID. etc). By default. To insert a context member defined in a context favorite. the member name that is applied is the one that is currently used in the context bar. See Refresh Data on the Whole File when Opening it. See Auto Fit Column Width. 303 2013-09-04 . http://msdn. See Repeat Row Headers and Repeat Column Headers. The default format is the following: 0. See Display Name.## (no 1000 separator and 2 decimal numbers).mi crosoft. deselect Inherit Document Options or Inherit Presentation Options. However. To do so. Show Unauthorized Cell Text Report Options By default. All the characters that are supported are listed here: http://msdn. note that the Hide Empty and Hide Empty and Zero Values features are not available in the dropdown lists. You can change this format. Repeat Row Headers and Repeat Column Headers.microsoft. See No Data and Zero Values. Auto Fit Column Width. the report options are the ones defined for the current file in the Document Options or Presentation Options. including or not a 1000 separator and a decimal number. Number Format option. the following options area available: Note: All the other options are greyed out.aspx. You can modify the options for the current report in the Options tab of the Report Editor. • • • • • • • Totals options. Note: Some options are always available for selection.3 Options in the Add-in for Microsoft Office Word and PowerPoint Document or Presentation Options In the Document Options or Presentation Options. Show Unauthorized Cell Text. Clear Data on the Whole File when Saving it.aspx.EPM Add-in for Microsoft Office Word and PowerPoint 38. All the options that remain greyed out are the ones that are greyed out in the Document Options or Presentation Options. See Clear Data on the Whole File when Saving it. See Totals Placement . Display Name. See Report Options.com/en-us/library/dwhawy9k. See Empty Cell Default Value .com/en-us/library/0c899ak8. Set Default Value in Empty Cell and Empty Cell Default Value options. No Data or Zero Values. The area enables you to enter how you want the data numbers to be displayed. • • • Refresh Data on the Whole File when Opening it. EPM Add-in for Microsoft Office Word and PowerPoint 304 2013-09-04 . copy or move data within and across applications. In addition.1 About Data Manager 39.lgf file. and export data from an application for use in an external tool. version for SAP NetWeaver The Data Manager is integrated with the Excel interface. version for the Microsoft Platform. which is contained in the default.1 About Packages A package is a set of specific tasks that define the work to be done. The Data Manager is used with both • SAP BusinessObjects Planning and Consolidation. most packages automatically run default logic. These tasks are based on information you provide either by entering information in Data Manager package prompts. You can set up system logic to work together with packages in the Data Manager. The Data Manager also allows you to export transactional and master data from an application within Planning and Consolidation to a file that you can use in an external tool.1. version for the Microsoft platform • SAP BusinessObjects Planning and Consolidation. When using the Data Manager with SAP BusinessObjects Planning and Consolidation 10. 39. for your application. When you import data.Data Manager Data Manager 39. You can also include logic files in packages. Click the Data Manager tab to start the Data Manager. or you can prompt users for logic files that they would like to use. 305 2013-09-04 . the Data Manager supports mapping and complex transformations of data.1. you can also modify packages directly through Microsoft SQL Server.1.1 About Data Manager The Data Manager is a Planning and Consolidation module that helps you move data into the system. which means that you are not required to modify them in order for the packages to work with your models and dimensions. there are three types of packages within the Data Manager: • • • Data Management Financial Processes System Administration Note: By definition.1. You can modify packages to behave differently or to perform additional functions.2 About Process Chains A process chain is a sequence of processes that are scheduled to wait in the background for an event. Packages in the Data Manager are standard and shared among all models within all environments in a given Planning and Consolidation installation. a package in the Data Manager is anything that has been added either by default or as the result of customization in the "Run Package" dialog box. A process in the context of process chains is a procedure inside of or external to an SAP system with a defined beginning and end. In the "Organize Package List" dialog box you can do the following: • Add a package • Modify a package • Remove a package • Copy a package • Move a package The planning and consolidation application version for Microsoft relies on SSIS packages whereas the version for SAP NetWeaver relies on process chains. Related Topics • Load Process Chain Examples • About the Import and Send Email Process Chain • Using the SendMail Process Chain 306 2013-09-04 . Some of these processes trigger a separate event that can in turn start other processes.1. The packages that come with Planning and Consolidation are designed to be dynamic. such as legal consolidation and intercompany booking. By default. Related Topics • Running a Copy Package • Running Packages 39.Data Manager Packages allow you to move data among your Planning and Consolidation databases and to effect business processes. 1. or launching packages.2 Standard Packages 39. 39. If a file has an associated transformation file. organizing.3 About the Data Manager Connection The data manager connection is used to launch actions related to Data Manager.1 Standard Data Management Packages You can use the packages provided in the Data Management package group to perform general data management tasks. you can modify the file or assign it directly to the package. If you change the data manager connection from the Data Manager menu you do not change the current connection used to create reports. such as running. 307 2013-09-04 .2.1.Data Manager • Using the FTP Process Chain 39. The "Default Formulas" package executes default formulas stored in your Default. You are prompted to enter a name for the export file and for a data selection to export. into an ASCII file. including calculated values. The "Export Dimension Members" package exports dimension members. text. You are prompted for the following selections: • • • • • • • Destination A transformation/mapping file Source application Filter for dimension values A delimiter Whether to include a header Whether to include calculated members 308 2013-09-04 . You can use the import. The "Copy" package copies data between dimensions within the Planning and Consolidation application. You are prompted for the following selections: • • • • • • • • • • Filename Destination Source dimension A transformation file Language Filter for dimension values A delimiter Whether to include a header Whether to include calculated members Whether to include selected hierarchies Copy Default Formulas Export Export Dimension Members Export Transaction Data The "Export Transaction Data" package exports transaction data from an application to a flat file. You can use the export.Data Manager Package Name Clear Description The "Clear" package clears the data in the Fact and FAC2 table by importing zero values. Running this package also clears comments from the comments table.LGF file.xls transformation file with this package. The optimize process clears all values from the table.xls transformation file with this package. and hierarchies. The "Export" package exports data values from the Planning and Consolidation cube. including master data. to a flat file. Ownership Calculation The "Ownership Calculation" package calculates the overall ultimate ownership of an entity based on actual control of that entity.lgf.xls transformation file with this package.1. The signs of the amounts are reversed based on the Account type.2. the package clears the records in the source table. 39.1.xls transformation file with this package. The "Import Master Data" package allows you to load dimension member data directly into a Planning and Consolidation Dimension's Member Table. is provided as an empty file. The "Import" package imports one or more ASCII files into the current application.1. You are prompted for source and destination data selections for all dimensions. You are prompted for one or more import files and associated conversion files. The package clears records in the fact table in the destination before it moves records from the source fact table. Move The "Move" package lets you move any selection of data within an application. When the records have been moved to the destination.1 Examples of Standard Data Management Packages 39.1 Copy Example The copy package copies data between dimension members within applications 309 2013-09-04 .2. You are prompted for the following selections: • • • • • One or more import files A transformation file The import mode (merge versus replace and clear) Whether to run default logic Whether to check work status settings Import Import Master Data Import Transaction Data The signs of the amounts are reversed based on the Account type.Data Manager Package Name FX Restatement Description The "FX Restatement" package is used for currency translation. FXTrans. You can use the import. The "Import Transaction Data" package imports one or more ASCII files into the current application. You can use the import. A sample logic file. 1.CASH1.2006.2006.0 • ACTUAL.CASH1.300 Pre-Copy Target Data • ACTUAL.1.Data Manager Prerequisite: The target cube must contain the following dimensions: • • • • Account Category Entity Time The target data is aggregated prior to the copy process. Note: All members are copied for the Time.2006.CASH1.MAY.CASH1.2.150 Result Post-Copy Target Data • ACTUAL.2 Move Example The move package lets you move any selection of data within an application.JUNE.2006. The source fact table records are cleared after they are moved to the destination.JULY. The transaction data in source is not affected by the copy process.2006. The destination fact table records are cleared before the source records are moved.300 39.CASH.2006.JULY.100 • ACTUAL.CASH.200 • ACTUAL. Entity. Selections • Source selection: Account=CASH • Target selection: Account=CASH1 Source data • ACTUAL. and Category dimensions.MAY.200 • ACTUAL. The process is as follows: the transaction data in the target selection is cleared to 0. You are prompted for source and destination data selections for all dimensions.CASH1.JUNE. All of the transaction data in the source selection is written into the target.2006. Prerequisite: The target cube must contain the following dimensions: • Account 310 2013-09-04 .MAY. 0. and Time dimensions.JULY. The process is as follows: if the record already exists in the data file in the cube. the record in the cube is overwritten by the corresponding record in the data file. Category.CASH1.300 39.CASH1.2006.CASH.2006.1.JULY.3 Import Transaction from a Data File Example The Import Transaction from a Data File package imports one or more ASCII files into the current application.200 • ACTUAL. The transaction data in the source selection is be written to the target.0 • ACTUAL. Prerequisites: • • The target cube contains the Account.2006.Data Manager • • • Category Entity Time The target data is aggregated prior to the copy process. The target data is aggregated prior to the copy process.0 • ACTUAL.CASH1.100 • ACTUAL.300 Pre-Move Target Data • ACTUAL.CASH1.MAY.CASH.2006.150 Result • Post-Move Source Data • ACTUAL.2.2006.200 • ACTUAL.CASH1. The transaction data in the source is cleared to 0.JUNE.0 Post-Move Target Data • ACTUAL.0. Selections • Source selection: Account=CASH • Target selection: Account=CASH1 Pre-Move Source Data • ACTUAL. Note: All dimension members in the record are treated as a composed key.JUNE.CASH1. 311 2013-09-04 .CASH.2006.MAY.2006.2006.1. The process is as follows: the transaction data in the target selection is cleared to 0.MAY.2006. Prerequisites: • • The target cube contains the Account.1.2006. If there are duplicate records in the data file. If the source dimension member does not exist in the environment.CASH.4 Import Master Data from a Data File Example The import master data from a data file package allows you to load dimension member data directly into a Planning and Consolidation Dimension's Member Table.JULY.500 ACTUAL. do not change.MAY.700 Result Post-Import Cube Records ACTUAL.JAN.Data Manager If the record does not exist in the data file.CASH.300 Pre-Import Cube Records ACTUAL. Note: ID is the only key that can be used to determine whether or not the member already exists.CASH. 312 2013-09-04 .300 ACTUAL. just the last record is written into the cube.500 ACTUAL.JULY.2006.CASH.2006. but not in the source file. the source dimension member overwrites the member that exists in the application set.CASH.2006. the source dimension member is inserted into the environment as a new member. it is inserted as a new record.2006. Records in the Data File ACTUAL.MAY. If the source dimension member (the member record in the data file) already exists in the environment. Category and Time dimensions.MAY.200 ACTUAL. The target data is aggregated prior to the copy process.1. Example: In this example.700 39.CASH. the dimension is Account and the first date column is ID.CASH.600 ACTUAL. The records that exist in the cube (but not in the data file) are not affected.2006.2006.CASH.2006.JAN. The dimension members in the environment.MAY.2. .ENTITY") TASK(TASKNAME.DATATRANSFERMODE..... 39........0) TASK(TASKNAME. 11112001..AST. 11000000.MDX....Current Assets.........PROCESSCUBE.1) TASK(TASKNAME..FILE.TIMEIDFORMAT..ST.C:\..RPTCURRENCY") TASK(TASKNAME.) TASK(TASKNAME.TIME."CATEGORY..USER.Current Assets...1) TASK(TASKNAME... The syntax is as follows: TASK(TASKNAME....ST..TIME.PROCESSCUBE_FAC2...) TASK(TASKNAME.ENDFLOW.GETMEASURE.) 313 2013-09-04 .F_900. Result Post-Import Environment Account Members 10000000.Petty Cash..txt) TASK(TASKNAME.SQL..AST.AST.1....DESCRIPTION.) TASK(TASKNAME.VALIDATETMPFILE.ENDFLOW.F_900.APPSET.....MAXMEMBERS.\Webfolders\ApShell\Finance\DataManager\DataFiles\Examples\Import....DTSTask_EvDTSDumpLoad..F_900...) TASK(TASKNAME..0) TASK(TASKNAME...TASKNAME) TASK(TASKNAME.tonyd) TASK(TASKNAME.) TASK(TASKNAME.2...DATASRC.AST.. 11110000.INTCO...ENDFLOW.F_900..apshell) TASK(TASKNAME.ENTITY...ASTAA.MACHINENAME.NAME.0) TASK(TASKNAME...RUNTHELOGIC.......ENDFLOW.. • Exporting from Cube You can export an ascii text file that contains data from you Planning and Consolidation database • TASK Commands in the Load Process Chain You can use the following TASK commands in the Load process chain... Pre-Import Environment Account Members 11110000.....Petty Cash.ST.. • Importing Into Cube You can import a correctly-formatted ascii text file directly into the database.ENDFLOW.APP.PROCESSMODE.ST.SELECTIONFROMTASK..DIMLIST.) TASK(TASKNAME.CLEARDATA.Cash1.SELECTION.....2 Load Process Chain Examples The Load process chain has many useful data dump and data retrieval functions as follows: • Processing the Application You can import data when you process the application or you can process the application without importing data. 11112001.... 2) TASK(TASKNAME... 11000000..) TASK(TASKNAME.clsEvDTSDumpLoad_1) TASK(TASKNAME.F_900...ST..Data Manager Source Data 10000000.. 11110000."CATEGORY...ACCOUNT. 11112001.....finance) TASK(TASKNAME.. Data Manager TASK(TASKNAME. The default administrative packages are described in the following table: 314 2013-09-04 . by default. These packages are also designed for metadata and master data maintenance. Package Name Allocation Description The "Allocation" package processes allocation logic for the user.2. They can also be designed in a single custom process chain for overall system maintenance.3 System Administration Packages Administrative packages are designed to perform operational tasks on the database. such as back-end data manipulation.2. Using tasks that have been provided. you can optimize and manage non-application cube data.DMMCOPY. and allocation according to the logic defined in allocation.lgf The "FXtrans" package is used for currency translation.) 39. environment. The majority of these tasks can be executed using either the Data Manager or the administrative console." 39. FXtrans Note: The packages in this group are of the task type "User Package.2 Financial Process Packages The following table contains standard financial processes packages that have been have been added to the Data Manager. category. 315 2013-09-04 . This package can also perform the following functions: • • Process the data into the Planning and Consolidation cube Run default logic against the imported data set. SAP BusinessObjects Planning and Consolidation provides several additional packages that you can add to the Data Manager. Archive Audit Activity The "Archive Audit Activity" package can be used to schedule archiving operations for audit activity.3. Archive The "Archive" package can be used to schedule archiving operations for selected dimensions. These packages are either Microsoft SSIS packages or process chains. depending on the version of the planning and consolidation application that you are using. 39. and time member combinations found in the data source file and imports the data into the database. The sample packages are located on the Planning and Consolidation file server in the \\DataManag er\PackageFiles\Examples folder of the associated environment and model.3 Additional Packages 39. Note: The packages in this group are of the task type Admin Package.Data Manager Package Name Append Description The "Append" package clears the table for all entity. The following table describes the sample packages.xls transformation file with this package. You can use the im port.1 About Additional Packages In addition to the standard packages provided with the Data Manager. For example. For example. or full option. NW MS MS MS AdminTask_Process AdminTask_Validate Append AuditBackup AuditClear 316 2013-09-04 . MS MS Admin_Optimize AdminTask_LogicValida Validates the logic file. Other than the ImportUsingFTP process chain. Clears audit data. MS This process chain validates the logic file. if a new member ID is added. you do not need to modify process chains before you can add them as packages and run them.Data Manager 39. tion AdminTask_MakeDim This process chain creates dimension members and NW schedules the processing of dimension members. Optimizesmodels with lite. These packages are available to all environments. The example package defines the user interface that passes information to the process chain. Processes the application with incremental or full option. this process updates the FAC2 table with the updated list. incremental.1. Appends an ASCII file into the current application. you can use an example process chain as the starting point for a custom package. Note: The ImportUsingFTP process chain must be modified before it can be used. Backs up audit data. Alternately.3. this process updates the application data with the updated list. Package Name Admin_Makedim Description Version Creates dimension members using a SQL table and MS schedules the processing of dimension members.1 Example Packages Data Manager provides example packages that consist of process chains. if a new member ID is added. MS Export the Journal tables Full_Optimize This process chain schedules a full optimization. This option takes the system offline. Running this package also clears comments from the comments table. Export_Journal This process chain prompts you for the name of the export NW journal file and exports the Journals table.xls file. Copies the model database. The MS optimize process synchronizes the FACT and FAC2 tables with the cube. Clears comments from the comments table. MS MS NW ClearComments Copy Model Copy from Fact Table Copies the FACT table. Version MS MS MS Clear from Fact Table Removes the data from the FACT and FAC2 tables. Exports the Journals table to an output file. Default_Formulas This process chain executes default formulas stored in your default. time NW dimensions. It is best run during non-business hours. and currency to clear from the "Journals" table. bles Clear_Journals MS This process chain prompts you to select categories. Clear the Journal Ta Clears the Journals table and creates an output file. This process chain clears comments from the "Comments NW " table.Data Manager Package Name AuditPurge AuditRestore ClearComment Description Purges audit data. It clears NW both real-time and short-term data storage and processes the dimensions. Restores audit data. 317 2013-09-04 . Note that when these descriptions are entered in another language in the EVDESCRIPTION table (and the correct SAP NetWeaver language code is used).xls transformation file with this package.MS ble. Import_Descript MS This process chain imports dimension member description NW records. NW ICData (Intercompany Reconciliation) IC_Elimination Import This process chain imports an ASCII file into the current NW application. categories. Available for the purposes of backward compatibility. categories.Data Manager Package Name ICBooking (Intercompany Balance Booking) Description Version This process chain tracks Intercompany balances to per. You can specify the transformation file that defines conversion as well as data value signs. NW ImportAndSendMail Import Category by Imports Category by Time data into the fact table. You can use the import. You Time into Fact Table can use the Category_By_Time. selection. This process chain imports an ASCII file and send the result to a specific user. and processes Intercompany booking according to the logic defined in icbooking.lgf This process chain prompts you for entities. and selection according to the logic defined in icdata. MS Import Dimension 318 2013-09-04 . environment. model. model. This setting can be modified in Interface for the Web. MS Import Access 2007 Import Access 2007 into Fact Table Imports the Microsoft Access database into the FACT ta. and time dimensions for the user.lgf This process chain is used to perform Intercompany eliminations. Imports the MS Access 2007 database into the FAC2 table. environment.xls transformation file with this package. and time dimensions and processes Intercompany booking for the user. the descriptions appear in the language specified by the user. This process chain prompts you for entities. NW currencies. currencies.NW form Intercompany eliminations. xls transformation file with this package. model. NW and time dimensions. according to the logic defined in consolidation. Import SQL into Fact Imports a Microsoft SQL Server database into the FACT MS Table table.Data Manager Package Name Description Version Import Excel2007 into Imports a Microsoft SQL Server database into the FACT MS Fact Table table. When running this package. environment. Import SQL Imports a Microsoft SQL Server database into the FAC2 MS table. Imports an ASCII file and sends the result to specific user. you are prompted for the SQL database and table to import. This process chain prompts you for categories. When running this package. Allows you to import an ASCII file to download from an MS FTP site into the current application. you are prompted for the SQL database and table to import. You can use the import. Import Excel2007 Imports the contents of a Microsoft Excel 2007 file into MS the Fac2 table. When running this package. You can use Microsoft SQL to modify the server name in the package. currencies. After you modify the server name.xls transformation file with this package. and calculates consolidation for the user. and selection. You can use the import. you can run this sample package at any time. so you can schedule it to run during normal business activity ImportUsingFTP ImportAndSendmail Import_Using_FTP Legal_Consolidation Light_Optimize 319 2013-09-04 . you can run this package at any time. This option does not take the system offline. A light NW optimization clears real-time data storage and moves it to short-term data storage. After you modify the server name. MS This process chain allows you to import an ASCII file to NW download from an FTP site into the current application. you are prompted for the SQL database to import. You can modify the server name within the package.lgf This process chain schedules a light optimization. Data Manager Package Name Load_Infoprovider Description Version This process chain allows you to load data from one BI NW Cube into a Planning and Consolidation Application. model. NW and time dimensions. categories. environment. OwnershipCalc OwnershipCalculation Performs calculations typical of a statutory consolidation application. It is located in the Ownership environment in Apshell. accounting method. environment. and selection. and time dimensions. environment. NW currencies. and time dimensions. and parent information) for the user.lgf 320 2013-09-04 . and calculates ownership (including ownership percentage. Restore the Journal table Restore_Journals Restores Journasl tables from an output file. according to the logic defined in consolidation. according to the logic defined in calcaccount. currencies. categories. This process chain restores the Journals table from an output file. associate a transformation file. and selection. Opening_Balances This process chain prompts you for entities. MS Move from Fact Table Moves data from the FACT table. NW currencies. model. and calculates opening balances for the user.lgf This process chain prompts you for categories. and runs calculate account for the user. To map the data. holding method. and selection. model. NW RunCalcAccount This process chain prompts you for entities. DTSTask_Ev4DTSSendMail.MS poses.clsDTSSendMail_1) TASK(TASKNAME. merging data versus replacing it for identical records) • Run default for stored values after the import • Check work status settings during the data import • Choose email recipients To enable the system to send email.) TASK(TASKNAME.MAILATTACHMENTS.MAILMESSAGE. NW Validate_Transform Validations This process chain prompts you for dimensions and cate.2. 39.1.MAILSUBJECT. complete the To and CC fields in a package that you are creating or modifying.3. which is designed for your specific needs.Data Manager Package Name Scenario Modeling Description Version Allows you to use scenario modeling for forecasting pur.3.NAME.MAILCC.MAILTO.) TASK(TASKNAME.MAILUSER. This process chain validates the transformation file.2 About the Import and Send Email Process Chain You can use the "Import and Send Email" process chain to allow a user to do the following: • Select files to attach to the email • Designate a transformation file for the imported files • Select the import method (that is. use the following TASK commands: TASK(TASKNAME.) TASK(TASKNAME.TASKNAME) TASK(TASKNAME. 39. you must set up the email system parameters.) TASK(TASKNAME.MAILAPPSET. This package calls a logic file. To automate the completion of these fields.ADDRESULT.1.0) 321 2013-09-04 .DESCRIPTION. as defined in validation.1 Using the SendMail Process Chain To use the SendMail process chain.) TASK(TASKNAME.) TASK(TASKNAME.lgf by default.NW gories on which you can run validation logic.) TASK(TASKNAME. 0) 39.clsEvDTSFTP_1) TASK(TASKNAME.900 Result Post-Import Cube Data ACTUAL.JAN.JAN.PORTNUMBER. Post-Mapping Information Provider Data ACTUAL.CASH. using all of the dimensions as the key.CASH. If there are duplicate records in the data from the information provide.2006.FEB.) TASK(TASKNAME. ) TASK(TASKNAME.500 ACTUAL.200 ACTUAL.DESTSITE.CASH.DESCRIPTION.NAME.APR. The target data is aggregated prior to the copy process.2006.SOURCEPASSWORD.1. ) TASK(TASKNAME.2006.3 Using the FTP Process Chain You use the FTP task to transfer data files from an FTP site to the Planning and Consolidation server. ) TASK(TASKNAME.2006. Category and Time dimensions.0) TASK(TASKNAME.SOURCEFILENAME.200 Pre-Import Cube Data ACTUAL.CASH. all the duplicate records are aggregated. ) TASK(TASKNAME.2006.FEB.200 ACTUAL.3.2 Importing Transaction Data from an Information Provider Prerequisites: • • The target cube contains the Account.100 ACTUAL.TASKNAME) TASK(TASKNAME.2006. The records in the post-import cube are affected (but the data from the information provider is not affected).CASH.CASH. The syntax is as follows: TASK(TASKNAME.JAN.SOURCEUSERNAME. The data imported from the information provider overwrites the records in the cube that have matching keys.CASH.) TASK(TASKNAME.NUMRETRIESONSOURCE.2006.2006.CASH.APR.200 ACTUAL.3.OVERWRITABLE.DTSTask_EvDTSFTP.Data Manager 39.2006.CASH.700 ACTUAL.SOURCESITE.FEB.JAN.900 322 2013-09-04 . %TARGET_TM%. A non-administrative user can see the package. only users who are Planning and Consolidation Administrators can run an administrative package.version for Microsoft 323 2013-09-04 . The package can still be saved to a team that does not comprise non-administrative users. If the file contains packages. • If you select "User Package". but cannot execute it. users who have been assigned the Execute Data Management task security privilege can execute the task. the package generates an error when the package is executed. Field Description "File Name" When you click "File Name " a dialog box is displayed where you specify the file that contains the package. you can browse for files.1. The name of the package. If any field is incorrect or left blank.1 Adding Packages . • If you select "Admin Package". You can define a new group here.4 Adding or Modifying Packages 39.1 Package Properties The following table describes the fields you must complete when adding or editing packages. A description of the package.4. "PackageName" "Group" "Description " "Task Type" Example: PROMPT(MEMBERFROMTOINPUT. The folder group to which the package is added. you can view a list of available packages.Data Manager 39.Enter Source and Target Time.%TIME_DIM%. You can control who has access to run the package.4. Alternatively.%SOURCE_TM%.) 39. 4. 4. Right-click inside the "Add Package" dialog box and select Add Package. In the right side of the "Organize Package List" dialog box right-click and select Add Package. Type a description of your package. 7.1 Adding an Example Process Chain as a Package You add an example process as a package as follows: 1.version for NetWeaver When you add a package you add it to a package list in the OWNERSHIP\ folder. In the right side of the "Organize Package List" dialog box right-click and select Add Package.4. 2. click Organize > Organize Package List. then click Add. select the group to which you want to add the package. click Organize > Organize Package List. To add packages proceed as follows: 1. then click Open. Click Close. In the "Add Package" dialog box. In the Data Manager. The package is added to the package list. From the main menu select Organize > Organize Package List.4.Data Manager When you add a package you add it to a package list in the DATAMANAGER\PACKAGEFILES\ folder. 324 2013-09-04 . select the Task Type from one of the following: • User Package • Admin Package 6. 39. 3. To add packages proceed as follows: 1. 5. 7.1.2. 39. then click Add.1. then click Open. Click Select. 3. select the group to which you want to add the package. Click Close. Type a description of your package. Under "Group". Under "Group".2 Adding Packages . The package is added to the package list. select the "Task Type" from one of the following: • User Package • Admin Package 6. 8. 8. In the "Open" dialog box under "PACKAGEFILES" browse to locate the file that you want to open. 5. In the Add Package dialog box. In the Data Manager. 2. In the dialog box browse to locate the process chain that you want to open. 2. Click Select. 8.3 Modifying Packages . At this point you can do one of the following: • Change the file name • Modify the script • Change the task type • Select a different group • Modify the description 3. 4. then click OK. In the Data Manager.4 Modifying Packages. 325 2013-09-04 . Click Add.4. 6. 5. click Organize > Organize Package List. Type a package name and select a group. choose the package that you want to modify. click Save. In the Data Manager.version for Microsoft To modify packages proceed as follows: 1. Click Save. click Organize > Organize Package List. Select a task type. Click Save 39.1. right-click and select Modify Package. When you have completed your modifications. In the EPM pane. 2. version for NetWeaver To modify packages proceed as follows. 4. Under "Process Chain" click Select. When you have completed your modifications.4. 7.1. right-click and select Modify Package. In the EPM pane. click Save. 4. Type a description. 2.Data Manager 3. 1. At this point you can do one of the following: • Change the file name • Modify the script • Change the Task Type • Select a different group • Modify the description 3. choose highlight the package that you want to modify. 39. Browse to locate the process chain you want to add. In the "Modify Script" dialog box you can click an item to view a number of values such as tasks. You can also modify the "Dynamic Package Script".5 Customizing Packages Package customization requires modifying the script. Predefined Constant Description %ACCOUNT_DIM% %Model% %Model_List% %MODELPATH% Returns dimension name where dimension type = A. but they cannot match any of those in the following list. When you have finished your modifications click Save. 3. You modify scripts from the "Modify Package" dialog box. 2. and can be used within the context of the INFO instruction.4. which allow you to set values for variables used in package processing • TASK commands. 5. 1.1. 326 2013-09-04 .4.1. which opens a second "Modify Script" dialog box that allows you to access the following functions: • PROMPT commands. variables. Returns current model path. Click Modify Script .Data Manager 39. Returns a list of models. The path returned has the trailing back slash (\) appended to it. ClickAdvanced. which allow you to prompt the package user for selections or input • INFO commands. These variables are also available to other process chains within a package.1 Predefined Constants The following constants are in use by the system. which allow you to add one or more parameterized process chains to a package 4. and predefined constants. Related Topics • About INFO Instructions • Prompt Commands • Predefined Constants 39. Returns current model name. Expand "Functions" to view all the functions that you can modify.5. You can define your own variable names. Returns OLAP server name. Returns the current Data Manager data path. Returns the password for the Microsoft SQL Server. Returns dimension name where dimension type = R. Returns the Data Manager conversion folder path name. 327 2013-09-04 .Returns default measure type used in Planning and Consolidation. The path returned has the trailing back slash (\) appended to it. Returns list of measures. %DEFAULT_MEA. Returns logic folder path. The path returned has the trailing back slash (\) appended to it. Returns list of dimensions based on Microsoft SQL Server. The path returned has the trailing back slash (\) appended to it. %SELECTIONPATH% %SQLSERVER% %SQLPASSWORD% Returns list of measures. %MEASURES% %OLAPSERVER% Returns the Microsoft SQL Server server name. Returns dimension name where dimension type = C. Returns dimension name where dimension type = E.Data Manager Predefined Constant Description %ENVIRONMENT% %CATEGORY_DIM% %CONVERSIONPATH% %CURRENCY_DIM% %DATAPATH% Returns current environment name. SURE% %DIMS% %ENTITY_DIM% %FACTDIMS% %LOGICPATH% Returns list of dimensions based on the application. the system assumes all members for that dimension (the system does not insert a range for the dimension in the returned statement). Prompt commands are stored by package. but not to the COPYMOVE and SELECT prompts. data to export.%TEXT%. The path returned has the trailing back slash (\) appended to it. for example. This rule applies to all PROMPT commands asking for the selection of a file.4. When multiple PROMPT commands are entered in the same script.2 Prompt Commands Prompt Commands A PROMPT command generates customized dialog boxes that prompt end users for answers. Use the %TEXT variable to pass the returned value to the package for example. Returns short User ID (without domain name). Dynamically Passing Text to Logic You can dynamically pass text to logic as follows: 1. to return the value of the %TEXT% variable to the package: 328 2013-09-04 . All file selection prompts return the name of the selected file with the complete path. If the user leaves a selection field blank in a SELECT or COPYMOVE dialog box. Returns dimension name where dimension time = T. the user can select such things as the files to upload. Therefore. you can create multiple packages based on the same process chain template and provide different prompts to users for each package. 39. a delimiter or a text. or target applications for selected data. the system combines all of the prompts in one dialog box. PROMPT(TEXT.1. The COPYMOVE and SELECT prompts are presented to the user individually.Data Manager Predefined Constant Description %SQLUSER% %TEMPPATH% Returns Microsoft SQL Server user name. The path returned has the trailing back slash (\) appended to it. with as many dialog boxes as prompts are found in the script. You use the PROMPT commant to prompt the user for a value to pass to a logic file.5. Returns the Data Manager transformation folder path. Returns temp folder path for user. %TIME_DIM% %TRANSFORMATIONPATH% %TRIMMEDUSER% %USER% Returns full user name (with domain name). By completing these dialog boxes."select a year") 2. use the dynamically created function as follows: *XDIM_MEMBERSET TIME=MYYEAR. The syntax is as follows: PROMPT (CHECKBOX.LGF extension. The syntax is as follows: Syntax: PROMPT (CHECKBOX. Note: You cannot select or deselect the Activate option until you save the package. the logic file must use the . Choose <Package name> Dynamic Package Script (MODIFYSCRIPT) PROMPT 5.1) CHECKBOXGROUP Prompt() Command The CHECKBOXGROUT Prompt() command is used to present the user with a set of check boxes to select or leave empty. Select the Type cell and select a prompt. 2. 4.[label for check items] The default value can be 0 (unchecked by default) or 1 (checked by default). 329 2013-09-04 .[default value]) The default value can be 0 (unchecked by default) or 1 (checked by default). In the Data Manager logic. Note: You must separate multiple values with commas.Data Manager TASK(RUNLOGIC. Click Modify Script. 3. Select a package and choose Modify Package.INPUT Note: To enforce its validation at runtime. Example: PROMPT(CHECKBOX.[default values].[label]. [variable]."*FUNCTION MYYEAR=%TEXT%”) 3. Modifying Prompt Package Commands To modify prompt package commands proceed as follows: 1."Test for CheckBox". Enter data as required.%CheckBox%.[checkbox label text]. [variable]. Click Organize > Organize Package List.FORMULASCRIPT. CHECKBOX Prompt() Command The CHECKBOX Prompt() command is used to present the user with a checkbox to select or leave empty. All files(*."Test for Combobox:".1}. [path]) Where Means Default Value CONVERSION [variable] [label] [mask] [path] Select an existing DATA file."Test for CheckBox Group"."ch2"..0. [variable]. Data files (*.%CHECKGROUP%. The syntax is as follows: PROMPT(CONVERSION.t2.Data Manager Example: PROMPT(CHECKBOXGROUP. The syntax is as follows: PROMPT (COMBOBOX.[combo style].{1. [label]. *. [mask]. COPYBOXNO Prompt() Command The COPYBOXNO Prompt() command presents the user with a checkbox to select or leave empty.{"ch1".txt). The search path. this prompt type always presents the user with an empty checkbox.[select items]) The default value determines the preselected choice (in terms of ordinality."ch3"}. Example: PROMPT(COMBOBOX. starting with 0).) COMBOBOX Prompt() Command The COMBOBOX Prompt() command is used to present the user with a combination box (that is.0.*).%COMOBOBOX%.txt. Note: You must separate multiple values with commas.t2) CONVERSION Prompt() Command The CONVERSION Prompt() command is used to prompt the user for a transformation file to use. a drop-down list).t1. n/a The name of the returned variable %CONVERSION% The text to display to the user.*. By default.[default value].* The transformation files directory.[label]. [variable]. The types of files to select. 330 2013-09-04 . Please select a transformation file. . for export.. [second variable]. [default members]) 331 2013-09-04 . The syntax is: PROMPT(TRANSFORMATION.txt. [variable].. [path] Leave empty. *."Test for CheckBoxNo". [label].. The search path %TRANSFORMATION% Please select a transformation file. [path]) Where TRANSFORMATION [variable] [label] [mask] Means Select an existing DATA file. Data files (*. [variable]. [label]. [variable]. . Default Value n/a The name of the returned variable The text to display to the user The file type(s) to display in the selected folder Reserved by the system. The syntax is: PROMPT(SELECT.) Example: PROMPT(CHECKBOXNO..[label]. SELECT Prompt() Command The SELECT Prompt() command is used to prompt the user for a data range for example.Data Manager The syntax is as follows: PROMPT(CHECKBOXNO. [dimen sions].txt). The transformation file directory..%CHECKBOXNO%. [mask]..) TRANSFORMATION Prompt() Command The TRANSFORMATION Prompt() command is used to prompt the user for a transformation file. [label]) Where Means Default Value DELIMITER [variable] [label] The data delimiter The name of the returned variable The text to display to the user n/a %DELIMITER% Please select a delimiter. [label].Data Manager Where Means Default Value SELECT Select one data range SELECT Select one data range. [variable]. The syntax is as follows: PROMPT(DELIMITER. [variable]. for example). [dimensions]. The syntax is a follows: PROMPT(SELECTINPUT. [variable] [label] [dimensions] The name of the returned variable The text to display to the user The dimensions from which to select members %SELECTION% Enter your selection Category. Time.The members that are selected by default bers] Enter 0 for "All" Enter 1 to take into account the context member DELIMITER Prompt() Command The DELIMITER Prompt() command command is used to prompt the user for a delimiter to be used in the import or export file. [default members]) 332 2013-09-04 . Entity [default mem. . SELECTINPUT Prompt() Command The SELECTINPUT Prompt() command is used to allow the user to select only noncalculated members (export. %TAB%) TASK(/CPMB/ALLOCATION_LOGIC.Data Manager Where SELECTINPUT [variable] [label] Means Select one noncalculated data range Default Value n/a The name of the returned variable The text to display to the user. "Enter Target Entity".%SOURCEENTITY%) If you need more than one SELECTINPUT prompt command. [path]) 333 2013-09-04 . [mask].%SOURCEENTITY%.SELECTION. The syntax is as follows: PROMPT(INFILE.SOURCE%EQU%%SOURCEENTITY%%TAB%TARGET%EQU%%TARGETENTITY%) INFILE Prompt() Command The INFILE Prompt() command is used to prompt the user for a file to import."%ENTI TY_DIM%")TASK(/CPMB/ALLOCATION_LOGIC.%SOURCEENTITY%.%TEXT%) INFO(%TAB%.REPLACEPARAM.%EQU%) TASK TASK(/CPMB/ALLOCATION_LOGIC. Time.The members that are selected by default bers] Enter 0 for "All" Enter 1 to take into account the context member Note: If you need ony one SELECTINPUT prompt command. . use the following syntax to create the script: PROMPT(SELECTINPUT.."%ENTITY_DIM%") PROMPT (TEXT."%ENTITY_DIM%") PROMPT(SELECTINPUT.%TARGETENTITY%. . %SELECTION% Select the desired data range Category.TEXT%EQU%%TEXT%) TASK(/CPMB/ALLOCATION_LOGIC. . Entity [dimensions] The dimensions from which to select members [default mem. [label].=) TASK(/CPMB/ALLOCATION_LOGIC.TAB. use the following syntax to create the package script: PROMPT(SELECTINPUT. "Enter Source Entity". "Enter Source Entity".MEMBERSELECTION.EQU.) INFO(%EQU%. [variable]. PROMPT(TEXT.*).. [label].txt.*. [VALIDATE LIST]) Where Means Default Value TEXT [variable] [label] [PWD] This is the function name. This parameter contains a list of items used to validate the input text. The delimiter must be a comma.txt). The syntax is as follows: PROMPT(TEXT."%Model_List%") 334 2013-09-04 . [PWD]. [variable].%ModelList%. The system validates the user entry against a model list."Application list:". *.* [path] The data files directory TEXT Prompt() Command The TEXT Prompt() command is used to display a text message to the user. Data files (*.All files(*.Data Manager Where Means Default Value INFILE variable] [label] [mask] One or more data files The name of the returned variable The text to display to the user The file type(s) to display in the selected folder The search path n/a %FILE% Please select a file. and the list must close with a double quotation. The name of the returned variable The text to display to the user None %TEXT% None Use this variable when you want to display the password as asterisks None (*****) in the text box. None [VALIDATE LIST] Example 1: This function shows a text box with the label Model list. [label]. [variable]. [label].E") Example 4: This function shows a text box with a password value shown in asterisks (*). The system validates the user entry against A. [variable].*).* [path] The selection files directory.txt).. The syntax is as follows: PROMPT(OUTFILE. OUTFILE Prompt() Command The SELECTION Prompt() command is used to prompt the user for the name of the export file.txt. The system validates the user entry against a dimension list.."A.%AlphabetList%. [path]) Where SELECTION [variable] [label] [mask] Means Select an existing data selection file.E.*."%DIMS%") Example 3: This function shows a text box with the label Alphabet list:.PWD) SELECTION Prompt() Command The SELECTION Prompt() command is used to prompt the user for an existing data selection file. The name of the returned variable The text to display to the user The file type(s) to display in the selected folder The search path Default Value n/a %SELECTION% Please select a file Data files (*. PROMPT(TEXT. *. [mask].C.All files(*.B.Data Manager Example 2: This function shows a text box with the label Dimension list:.B. The syntax is as follows : PROMPT(SELECTION.%Password%.D. [path]) 335 2013-09-04 .D.%DIMLIST%. PROMPT(TEXT."Alphabet list:". PROMPT(TEXT."Please enter your password".C."Dimension list:". [mask]. *.txt. *. [default members]) 336 2013-09-04 . [variable].All files(*.*). [la bel].Data Manager Where OUTFILE [variable] [label] [mask] Means An existing DATA file. the syntax is as follows: PROMPT(COPYMOVEINPUT. The name of the returned variable The text to display to the user The file type(s) to display in the selected folder The search path Default Value n/a %FILE% Please select a file.txt). Data files (*. for example). [dimensions]. [second variable].* [path] The data files directory COPYMOVEINPUT Prompt() Command The COPYMOVEINPUT Prompt() command prompts the user for two noncalculated data ranges (for copying data. Example: enter 11 to have the context members proposed by default in the source and the destination dimensions. The syntax is: PROMPT(COPYMOVE. PUT [variable] [label] The name of the returned variable The text to display to the user. Time. [default members]) 337 2013-09-04 . [second variable].Select noncalculated data ranges. [dimen sions]. n/a %SELECTION% Please select a file. Category. [label]. Entity [dimensions] The dimensions to select from [default members] The members that are selected by default for the source and destination dimensions 0 stands for "All" 1 takes into account the context members Example: enter 01 to have all members by default in the source dimensions and the context member in the destination dimensions.Data Manager Where Means Default Value COPYMOVEIN. COPYMOVE Prompt() Command The COPYMOVE Prompt() command is used to prompt the user for a source and destination data range. [variable]. The syntax is as follows: PROMPT(CHECKBOXYES. COPYBOXYES Prompt() Command The COPYBOXYES Prompt() Command presents the user with a checkbox to select or leave empty.."Test for CheckBoxNo".. n/a %SELECTION% %TOSELECTION% Enter your selection The text to display to the user... The name of the returned variable. The name of the second returned variable. Example: enter 11 to have the context members proposed by default in the source and the destination dimensions. [variable].[label].%CHECKBOXNO%... this prompt type always presents the user with a selected checkbox. [default members] The members that are selected by default for the source and destination dimensions 0 stands for "All" 1 takes into account the context members Example: enter 01 to have all members by default in the source dimensions and the context member in the destination dimensions.) INFILES Prompt() Command The INFILES Prompt() command is used to prompt the user for a file to import.Data Manager Where Means Default Value COPYMOVE [variable] [second variable] [label] Select two data ranges. By default.) Example: PROMPT(CHECKBOXNO. The syntax is as follows: 338 2013-09-04 . [variable]."When this package is running. Example: PROMPT(MESSAGE.[label]. *. The syntax is as follows: PROMPT(LOGICFILE.lgf MESSAGE Prompt() Command The MESSAGE Prompt() command sets the text to be displayed to the user at the time the package is set.* LOGICFILE Prompt() Command The LOGICFILE Prompt() command is used to prompt the user for a logic file to import.lgx.[mask]) Where Means Default Value LOGICFILE [variable] [label] [mask] One or more logic files The name of the returned variable The text to display to the user The file type(s) to display in the selected folder n/a %LOGICFILE% Please select a file. *. *.Data Manager Where Means Default Value INFILES [variable] [label] [mask] One or more DATA files The name of the returned variable The text to display to the user The file type(s) to display in the selected folder n/a %FILE% Please select a file. 339 2013-09-04 . end user functionality will be affected: Data cannot be sent to the database or incorrect numbers can be retrieved from the database") RADIOBUTTON Prompt() Command The RADIOBUTTON Prompt() command is used to present the user with a radio button control. [label]."Select whether to check work status settings when importing data."No.[source_variable]. The syntax is as follows: PROMPT(MEMBERFROMTOINPUT.[values for choices]) Example: PROMPT(RADIOBUTTON.1. do not check work status settings"}. [variable]. *.[dim_type].{"1".[label]) 340 2013-09-04 . [mask]."0"}) SELECTIONFILE Prompt() Command The SELECTIONFILE Prompt() command is used to prompt the user for a file to import.{"Yes.". The syntax is as follows: PROMPT(SELECTIONFILE. [label]. check for work status settings before import ing".[la bel for choices].%CHECKLCK%.* MEMBERFROMTOINPUT Prompt() Command The MEMBERFROMTOINPUT Prompt() Command is used to prompt the user for an existing data selection file.[default value]. [path]) Where Means Default Value SELECTIONFILE [variable] [label] [mask] Select existing DATA files. [variable].Data Manager The syntax is as follows: PROMPT(RADIOBUTTON. The name of the returned variable The text to display to the user The file type(s) to display in the selected folder n/a %FILE% Please select a file.[tar get_variable]. 1."C:\MyDir\") INFO(%FILE%. the task replaces the name of all INFO variables found in all executable instructions with the current value of those variables.. At runtime. before executing the executable instructions. %FILE%) You can nest one level of INFO variables inside other INFO variables as in the following example: INFO(%PATH%."value") The INFO instruction parameters are defined as follows: • variable name is the name of the variable • value is the value of the variable Instead of assigning a value directly to a task.%PATH%IMPORT. The following example illustrates how to define a variable with an INFO instruction and how to use it in another instruction such as TASK: INFO(%FILE%."FILENAME". Source variable Target variable The text to display to the user n/a n/a n/a Enter source and target time.TXT) TASK("EVIMPORT"."FILENAME".Data Manager Where Means Default Value [dim_type] [source_variable] [target_variable] [label] Select a data type. the value (or part of it) can be replaced with the name of a variable defined in an INFO instruction. The syntax for the INFO instruction is INFO("variablename".TXT) ITASK("EVIMPORT". 341 2013-09-04 . %VARIABLE%. It is not an executable instruction and does not affect the package directly.5. 39.3 INFO Instructions About INFO Instructions An INFO instruction is used to defin and assign a value to a script variable. which makes the script more readable and less subject to errors when the substitutions are performed.IMPORT.4. %FILE%) Note: We recommend the use of expressions that are enclosed between some easily identifiable characters such as the % character for example. Click Modify Script.%SQL_STATEMENT%) Dynamic Constants Dynamic Constants are predefined in the system. Save the package. 6. 4. These constants are also available to other process chains within a package. Under "Dynamic Package Script (MODIFYSCRIPT) >INFO " click INFO. Dynamic Constants are detailed in the following table: 342 2013-09-04 . right-click. 3. and can be used within the context of the INFO instruction. The exception to this rule is an INFO instruction that can be spread across multiple lines. They can contain predefined constants. . to enhance the readability of the scripts. Click Save... Select Organize > Organize Package List.. Highlight the package you want to modify.. You can define your own constants and use your own naming convention for the names. then select Modify Package. Multi-line INFO Instructions All instructions that you enter in package scripts must be written as one-line instructions..Data Manager All system-generated INFO variables comply with this practice. Note: You cannot select or deselect the Activate option until you have saved the package. ENDINFO Example: BEGININFO(%SQL_STATEMENT%) SELECT * FROM TBLFACT%APP% WHERE %SELECTION% ENDINFO TASK(SELECTION. but they cannot match any of those in the following list. 5. The syntax for Multi-line INFO instructions is as follows: BEGININFO(variablename) .(value) . Note: Multi-line INFO instructions cannot be nested and cannot contain other instructions.. 2. Adding INFO Instructions to a Package You add multiple process chains to a process chain using the TASK command as follows: 1.SQLSTATEMENT. Returns list of dimensions based on the model. Returns current model name.2 Logic Use in Packages 343 2013-09-04 . Returns the model's binary name.4. Returns dimension name where dimension type = C. The path returned has the trailing back slash (\) appended to it. Returns a list of models. %TIME_DIM% %USER% 39. Returns the time dimension.Data Manager Dynamic Constant Description %ACCOUNT_DIM% %Model% %Model_List% %APPBINAME% %Environment% %CATEGORY_DIM% %CURRENCY_DIM% %DATASRC_DIM% %DIMS% %ENTITY_DIM% %PACKAGE% %TEMPPATH% Returns dimension name where dimension type = A. Returns dimension name where dimension type = E. Returns temp folder path for user. Returns the dimension that contains the data source. Returns full user name (with domain name). Returns current environment name. Returns the name of the current package. Returns dimension name where dimension type = R. You can specify a different set of logic to run or you can specify that logic is not applied. global) is as follows: OBJECT(TASKNAME. You can perform the following tasks with packages: • Run or schedule packages • Organize your favorite packages into a selected packages list • View package status • View schedule status Note: Schedule status and package status are not identical. which is contained in logic. They can be defined as follows: • Package status displays the result of a package that has already executed.IMPORT1.FILENAME. most packages automatically run default logic. Access to packages in the Data Manager is controlled by task security set by an administrator. 344 2013-09-04 .Data Manager You can set up Planning and Consolidation logic to work together with your Data Manager packages.VALUE) Example: TASK(EVIMPORT.lgf. The OSoftTaskLogic2008 custom Microsoft SSIS task allows you to set up parameters and run logic file or logic subroutines 39.4.1 Data Manager Tasks You can run a package in the Data Manager or set the schedule on which it runs.TXT) 39. You can include a step inside a package that runs logic. When the model imports data. step.5.PROP ERTY. • Schedule status displays the schedule on which various packages are set up to run.5 Data Manager Tasks 39. connection.3 Package Object Syntax The syntax for package objects (task. Click Yes at the prompt. 2. If you want to run the package immediately. Highlight the package you want to remove and right-click.3 Running Packages To run a package proceed as follows: 1. select Run. In the "Run Package" dialog box select the package you want to run. Type or select the prompt values in the various dialog boxes. The choices are as follows: • Run • Schedule • Run and Schedule 6. Depending on the type of package you are running. 4. Click Run. then click Finish.2 Removing a Package from the List To remove a package from the list. 3.5. 39.5. Click Run Package. the Data Manager displays prompt values. 4. Note: When a package is run the data access rights of the user are applied. Related Topics • Scheduling Packages 39. Click Finish.Data Manager 39.1 Scheduling Packages You schedule packages to be run in the "Run Package" dialog box.5. proceed as follows: 1. Select Remove Package. 5. Click Organize > Organize Package List. 1. 3. 345 2013-09-04 . At one point you are prompted to select when you want to run the package.3. 2. 5. then copy the data from the source to the destination. the package does a straight copy of the data. 346 2013-09-04 . or use the "ModifyScript" package to set the work status dimensions. In the Run Package dialog box. 39. You can enter additional properties by clicking Advanced. SELECTIONFROMTASK. When you have finished entering the scheduling information."CATEGORY. Select when to run the package. Click Run Package. Click Next. 7. a message is displayed and you cannot continue to run the package. the copy package copies the data. then click Next. select the Copy package.TIME. the system copies work status settings with the data. If you select : • No.Data Manager 2. then click Run. then runs the default advanced formulas that apply to that data. select Enable Schedule. 2. 3. then click Next. You are prompted for source and destination data selections for all dimensions in the application. then click Finish.3. In the "Copy" screen select one of the following: • Merge data values. enter a "Name" and a "Description". Example: Task(Task Name[DumpLoad]. If they are not defined. Note: Since the Replace and Clear option uses work status dimensions to determine which records are cleared. work status dimensions must be defined in the application. 1. • Yes. Select the members to copy and the location to which you want to copy them.ENTITY. 8. leaving all remaining records in the destination intact (does not add to existing data) • Replace & clear data values if you want to clear data in the destination area using the selected dimension list. then click Finish. 6. You can define the dimensions in the "Administration Console". 4. If you select the Schedule option. Select if you want the system to copy work status settings when importing data. • No. If you select: • Yes. Under Schedule Properties select the frequency and time of day you want to run the schedule. 3. Select if you want to run default logic for stored values after importing. Under General. the system does not copy work status settings with the data then click Next. you are prompted to enter the scheduling details. if you want to copy all specified records. 4.2 Running a Copy Package A copy package copies data within an application.DATASRC") 5. NOV 2008.NOV Sales Sales Cash Cash 2000 1000 200 400 39.NOV 2008.NOV Sales Sales Cash Cash 1000 1000 200 200 Input file records: Category Entity Time Account Amount Actual Actual US EMEA 2008.NOV 2008.4 Defining a Package Link A package link is a series of tasks that are linked together in a sequence.5.NOV Sales Cash 2000 400 Results of import with clear: Category Entity Time Account Amount Actual Actual US EMEA 2008.NOV Sales Cash 2000 400 Results of import with merge: Category Entity Time Account Amount Actual Actual Actual Actual US EMEA US EMEA 2008. 347 2013-09-04 .NOV 2008.NOV 2008.NOV 2008.Data Manager Example: Below are the database records before an import: Category Entity Time Account Amount Actual Actual Actual Actual US EMEA US EMEA 2008.NOV 2008.NOV 2008. then Close. then select Add Package LInk. The new package link is added to the list of package links. then click Run. select a package and right-click.5. 2. 2. type a package link name and description.4. Click Save. Select Organize > Organize Package List. In the "Run Package Link" dialog box. version for SAP NetWeaver. 3.Data Manager Package links are a feature of SAP BusinessObjects Planning and Consolidation. right-click. In the next set of screens you choose to: • Run the package link • Set prompts to select the following: • an infoprovider to load data • a transformation file • the data transfer mode • the methold for importing data • run default logic for stored values • check work status when importing data 4. 2. Click inside the "Organize Package Link List" dialog box. Click Organize > Organize Package Link List.5. In the "Organize Package List" dialog box under "Package Name". Click Finish. A message advises you that the package link is running on the server. In the "Package Task" dialog box type a name and description for the task. select the package link that you want to run. 3.5 Modifying the List of Selected Packages You can organize the list of selected packages as follows: 1. To define a package link. Click Run Package > Run Package Link. You can do one of the following: • Add Package 348 2013-09-04 . In the "Link Tasks Status" dialog box. 39. 5. Select a package from the list provided. then click Add Task. 6.1 Running a Package Link To run a package link proceed as follows: 1. Select an option from the menu. then click OK. 4. 39. proceed as follows: 1. 3. The dialog box displays the details of the schedule including a history of when the package ran against the schedule. Select View Status >View Status The Package Status dialog box displays a resume of the various packages. Click OK or Cancel. Click View Status > View Schedule Status. Note: You can save the log as a . select the package.Data Manager • • • • Modify Package Remove Package Copy Package Remove Package 39. then click Detail.5.5. At this point you can modify the scheduling parameters. 39. 2.8 Adding Multiple Process Chains to a Package 349 2013-09-04 . 39. Select how you want to filter data.6 Viewing Package Status You can view the status of packages that are currently running and packages that have been completed as follows: 1. If you want to view the details of the schedule.5. 2.zip file by selecting Detail > Save Context As in the Detail log dialog box. 3.7 Viewing Package Schedule Status You can view the status of packages that have been scheduled. 1. The "Package Schedule Status" dialog box opens. then click Refresh. If you want to view the detail logs corresponding to the package. 4. which opens the "Job Detail" dialog box. double-click the schedule name. Select "Modify Package".Data Manager You can add multiple process chains to a process chain using the TASK command as follows: 1. the BADI is called for each package during the transaction data load. Select Transformation File > New Transformation File 2. Click Save.9 Importing and Exporting Data Having Multiple Key Figures You can import and export transactional data that consists of more than one key figure for the same source into the same Planning and Consolidation application by using an additional keyword in the mapping section of the transformation file.5. 4. 9.5. 3. 350 2013-09-04 . In the "Modify Script" dialog box. Before running the BADI process type you must specify the filter in the data package script to indicate to the system which BADI implementation to call. Browse to locate the package to which you want to add a package chain. 4. Save the transformation file. 39. 8. 7. 39. package name. Note: For master data. Proceed as follows: 1. under "Dynamic Package Script (MODIFYSCRIPT)" click "TASK".10 Retracting Master Data and Transaction Data You can retract both master data and transaction data using the BADI process type called by a process chain. Click Save. Click Organize > Organize Package List. You return to the "Modify Package" dialog box where you can modify the group. 3. the BADI is called only once since packaging is not supported. Under "Activate" select the tasks you want to include in the process chain. Run the package and choose the transformation file. 5. or description. for transaction data. however. Select the package then right-click. Click Modify Script. 6. Map the multiple key figures to the single key figure using a keyword in the mapping section of the transformation file. 2. You define *start_routine and *end_routine in the transformation file.Data Manager The BADI implementation (syntax) is checked during validation. For master data and transaction data. Example: In the transformation file: *Option *start_routine = <filtervalue_start> *end_routine = <filtervalue_end> For each data package. the system does not validate the syntax. The value for <filtervalue_start> and <filtervalue_end> must be unique. the system executes the BADI implementation for end_routine by the filter value = filtervalue_end. having different values may be more realistic. When validating a transformation file with a start_routine or end_routine. after transformation. the start_routine BADI is filled after the master data or transaction data has been read and made available. which displays the existing data initializations with the following information: • Name • Description 351 2013-09-04 . When calling BADI. For master data and transaction data. When *end_routine is not empty. before transformation. For transaction data. this value is used to find the correct BADI implementation. version for SAP NetWeaver. the system executes the BADI implementation for the start routine by the filter value = filtervalue_start.5. the system validates the results of these routines while the validation runs all code. You create delta initializations via the "Organize Delta Initialization" dialog box. except the commit (write). the BADI is based on the table level since master data extraction and retraction do not support packaging of data.11 About Delta Initialization Delta initialization is a simple process to prime the source system to record changes after an initial extraction of data is made. A user who has sufficient rights can use the Organize Delta Initialization feature in Data Manager. You must validate the syntax of your BADI implementation. the end_routine BADI is called before the write (commit to NW). the BADI is based on package level since packaging is supported. the value in <filtervalue_start> is used to find the BADI implementation that is called before transformation. For masterdata. Note: For the retractor BADI. For each data package. Although you can set the value for *start_routine and *end_routine to be the same. When *start_routine is not empty. 39. the value in <filtervalue_end> is used to find the BADI implementation that is called after transformation. • Filter a delta initialization by Name. 352 2013-09-04 . 5. Click the icon next to the "InfoProvider" box and. • Load the updated delta initialization from server. from the "InfoProvider Selection" window. If a delta initialization has not been triggered you can modify all parameters. The "Dimension/Field" list corresponds to the columns of source data in the InfoProvider. • Search in delta initializations. 2. 39. In the appropriate fields type a name and description for the delta initialization. which you access from the Organize menu.11. 4. Proceed as follows: 1. • Remove the selected delta initialization.fields. and attributes from which you want to load data.Data Manager • • • • • • • • • • • • InfoProvider Selection Status of latest load Time of latest load User of lates load Trigger full load at first run Number of the load Records of load Creating time Transformation file Package group of latest load Latest request From the Organize Delta Initialization dialog box you can also perform the following: • View the detailed parameters of a selected delta initialization. and Operator. In the "Organize Delta Initialization" dialog box click Organize > New.1 Organizing Delta Initialization You create a new delta initialization in the "Organiza Delta Initialization" dialog box. Attribute. Under the "Dimension/Field List" tab select the dimensions. Description and InfoProvider in the current page. 3. if it has been triggered you can modify only the description and field list. • Type a low and high value where appropriate. Note: You can delete a delta initialization only if it has not been triggered. • Modify a selected delta initialization.5. Under the"Selection"tab do the following: • Select the Dimension/File.select the InfoProvider you want to use. • Select whether to run the default logic. you can modify the description and field list only. 39. Click Run Package > Run Package. 1. A message informs you that the request to run the package on the server was successful and that the package is running. You can view the status of the package as well as the detail of the logs. Select the "Package Group" and "Package Name". Browse to locate the transformation file that you want to use.11. Other parameters appear greyed-out.2 Modifying a Delta Initialization If a delta initialization has not be triggered.6 Data Transformations and Conversions 353 2013-09-04 . 7. • Select when to run the package. If a delta initialization has been triggered.Data Manager 6.3 Running the Delta Initialization You run the delta initialization from the Run Package dialog box. 2. If you have already loaded this InfoProvider. 4. Click Save. 39. Click OK. • Select whether to check work status. If this is the first time you are loading this InfoProvider.11. you can modify all its parameters. A message box informs you that the InfoProvider has been created successfully and the name of the delta initialization appears in the "Organize Delta Initialization" dialog box. then in the dialog box type or select the name of the file that you are saving to the server. then click Run. 3. A series of screens open in the "Run Package" dialog box in which you perform the following: • Select the delta initialization you want to run. Click OK. 8. 39. 9. Click Finish.5. select Trigger a full load at the first run.5. do not select the trigger. When the Data Manager import package is run it reads the transformation file..1 About Data Transformations Data transformations allow you to map external data to internal Planning and Consolidation data structures.6. the source data must be in the proper format. named Instructions. defines which conversion sheet to use with which dimensions Conversion file The conversion file allows you to map member names from external to internal dimension structures. and correctly maps the data. click Transformation File > New Transformation File.Data Manager 39. Transformation files are Microsoft Excel files that contain one worksheet. which contains definitions for various options that you can set for your transformation • Mapping. which definies how data is mapped to the Planning and Consolidation database • Conversion. You can have one conversion file per dimension. Two interfaces for Microsoft Excel workbook files are required to perform data transformations. which displays the three sections. You can set up multiple sheets in a conversion file so that many transformations can access the same conversion workbook. you can define the correct dimension members in the conversion file. The files are as follows: File Description Transformation file The transformation file allows you to set up the rules for reading data from an external source and put it in the proper form for your system database.. In this case. The Excel page opens to the transformation worksheet. 39. 354 2013-09-04 .1. The Data Manager performs data transformations and mapping using transformation and conversion files. After you set up the transformation and conversion files you run packages to use those files to define the data transformation.1 Defining a Transformation File To define a transformation file proceed as follows: 1. which has a pointer to a conversion file. The Instructions worksheet contains the following sections: • Options. To be successfully imported. In Data Manager.6. xls!newaccount Account = [COMPANY]AccountConv.1.1 Transformation File: Options 1.xls is the name of the Account dimension conversion file. Account = AccountConv. In each section enter the required data for: • Options • Mapping Function • Conversion Example: AccountConv. and descriptions for each option: 355 2013-09-04 .xls (Use the Amount keyword with the ConvertAmountWDim transformation option. which displays the three sections. enter the required data.xls Amount = AccountConv. Data Manager click Transformation File > New Transformation File. The Excel page opens to the transformation worksheet. The following table contains a list of available options that the team lead or administrator can set for the transformation.Data Manager 2. In.xls!newaccount 39. 2.) Account = AccountConv. In the "Options" section.1. The following table contains a list of available options and descriptions for each option.6... the input member names are compared with the external column in conversion file. such as a comma. If NO. this parameter has no effect at all. For example. Recommendation: Do not change the default setting. The character specified in this option must differ from the character specified for the DELIMITER.10. in a case where the "Formula" column has the following formula: <value>*1. If YES. all accounts are increased by 10% during the conversion.Data Manager Option AMOUNTDECIMALPOINT=text character Default . (period) Description This option allows you to specify a non-period decimal point for countries that use a different character. This option compares input member names with columns in the conversion file. There are no reasons to change this in Planning and Consolidation 7. This setting is here for the purposes of backward compatibility only. the input member names are compared with the internal column in conversion file.0 and later versions. CONVERTAMOUNTWDIM=dimen. You must specify a dimension conversion sheet using the Amount *Conversion option.<Account> sion name CONVERT_INTERNAL = YES | NO NO CREDITNEGATIVE= YES | NO YES 356 2013-09-04 . This option specifies which dimension to look at for value calculations. If there is no formula in the Formula column of the "Amount conversion" sheet. then your input file contains one header row that defines the fields. It is illegal when running other packages DELIMITER text_character| SPACE . use the keywords SPACE or TAB if the columns are delimited by spaces or tabs. CREDITPOSITIVE = YES | NO If No. INC). which can be represented by an empty string. no matter how many rejected records exist. (comma) | TAB FORMULA = <empty> HEADER= YES | NO YES This option specifies if you data has a header row.Data Manager Option Default Description This option reverses the signs for a given account. This option specifies the number of rejected records at which to stop processing if you are validating records. This option defines the single character that is the delimiter between columns if the FORMAT option is set to DELIMITED. A value of -1 implies that the Data Manager should keep processing. INC) will have their signs reversed. you can refer to a field by name in the MAPPING section. The default value is 500. the option reverses the sign for all amounts referring to an ACCOUNT type (LEQ. If you do have a header row. MAXREJECTCOUNT=empty_string empty_string | -1 | positive number 357 2013-09-04 . Note: This option is only used for importing master data. If this parameter is set to YES. all amounts referring to an ACCOUNT type (LEQ. This option sets the K2 functions referenced by the master data member’s formula attribute. If this parameter is set to NO. If you use this option. there is no rounding during data transformation. but used to define the delimiter when using the transformation to export data.Datasrc. You must define this option.Amount. Entity.Account. By default. For example: MyCompany Data{CRLF}Category. you must enter a parameter. 358 2013-09-04 . This option specifies the amount of decimal places to which values are to be rounded during the transformation. Will be ignored if the transformation file is used to import data.Intco.RPTCurrency. The integer can be zero or any positive integer.Data Manager Option NULLAMOUNTVALUE = <text_character> OUTPUTDELIMITER = <text_character> | SPACE | TAB OUTPUTHEADER=<text_string> Default a space character Description Allows the business user to assign a value to null records.Time. empty string ROUNDAMOUNT=integer There is no default. The business user can use{CRLF} to create more than one row for the header. Note: The above example must be placed all in the same cell in the transformation file. Allows the business user to use a custom header to export data. (comma) Same as DELIMITER. <empty> name>. It is illegal when running other packages. Use the following parameter definitions to set your selection: • <Dimension1_techname> is the technical name of the dimension. US.0SX_CSLC. 359 2013-09-04 .<Dimension1_value>.<Dimension2_value> SKIP= integer 0 (zero) This option specifies the number of lines to skip at the top of a data file. • <Dimension1_value> is the value of a condition statement set to this dimension. Example: Use this option to skip header lines during transformation. Note: This option is used for loading transactional data SELECTION = <Dimension1_tech. 1 is the result of the following selection statement: 0SX_ACCS=US and 0SX_CSLC= 1 This option is only used for importing transaction data from an infoprovider. Example: 0SX_ACCS.<Dimension2_techname>.Data Manager Option Default Description This option sets the selection rules when you are extracting transaction data from an infoprovider. the record is skipped. • If the import file has an extra field that is not mapped. If this parameter is set to No. "Dallas. all records are rejected during validation. • Verify that the record is proper for the Planning and Consolidation application. For example. you must check the following items before the import: • Validate the mapping. When this option is enabled. This option specifies whether or not to validate records. validation does not occur.Data Manager Option SKIPIF= text_string | text_string2 Default empty_string Description This option causes the transformation to skip a line in the data file if it begins with the specified strings. If a record contains <text_string> or <text_string2>. the following rules apply: • If a member ID is not mapped.) and the text qualifier is a quotation mark ("). Texas" is considered as one value. the record associated with the ID is rejected during validation and ignored. VALIDATERECORDS= No | Yes No TEXTQUALIFIER= " [None] This option specifies the character that encloses a column value: the quotation mark (") character. 360 2013-09-04 . If you use this option. you must enter a parameter. in the above case. The strings are separated by |. • Ensure that the members exist. If this parameter is set to Yes. if the delimiter is a comma (. To include all lines in the transformation. set this option to an empty string. 6. you can map the "Account" dimension to the "Account" field from the data file as follows: Account = AccountVal The following table details the available mapping functions: Mapping Function Parameters Description COL(A) A = column index in the data file This function defines a dimension for a field in the data file when the data file does not have a header row.1:4) • • • Column index of the data file Delimier character Index of value by array that identified by delimiter FLD P_ACCT =P_ACCT(4 :12) Defines a subset of the values of a dimension. called "short name" as well.Data Manager 39.2 Transformation File: Mapping Function The mapping section of the transformation file defines how data is mapped to the Planning and Consolidation database.1. B:C) A = column index in the data file This function defines a dimension for a subset of a field in the data B:C = the start and end posifile.1. Example: For a header row that defines a column named "AccountVal". Example: Account =*COL(2) *COL(A. tions within the column Example: Account=*COL(3. 361 2013-09-04 . See the note below about automatic field names when you do have a header row. J A N . To see the sample time. In the following set of columns. N O V . O C T . A P R .xls conversion file. the time periods are named P1.PN by default. J U N . P3. you can use this function to include all of them.DATAS RC.xls conversion sheet. the columns 4 through 7 represent the Account dimension. J U L . Example: Account=*NEWCOL(Revenue) 362 2013-09-04 . If your data does not have a header row. *NEWCOL(A) A = dimension member This function creates a new field with the given value. F E B . Example: Account=*FCOL(4:7) *MVAL(A:B) or Dimension =*MVAL(keyfig uretype1|dim_mem1||key figure type2|dim_mem2||keyfig uretype3|dim_mem3) A:B = the start and end time period columns Use this command if the data file has multiple period columns. M A Y . P2.entity. D E C Using this command requires that you use a time. M A R .. open the existing conversion definition window.IntCo. you can use the following command: Time = *MVAL(7:18) Account.. S E P .Data Manager Mapping Function Parameters Description * FCOL(A:B) A:B = the start and end positions within the data row This option allows you to define the start and end character columns for each field when you are using Fixed format data files..Category. In the example below. Example: If you have a number of consecutive columns that are based on time periods.. A U G .RptCURREN C Y . D) A = Field name B = Total length C = Padding direction D = Padding character Use to format exported data into fixed-width records.If Condition1 is "False" and Condition2 is "True. map using this Default Action Condition1 and Condition 2 can contain multiple items that are added together (using the plus (+) sign) 363 2013-09-04 .L) Ac count=*Pad(Ac count. This function is useful if you need to map data file fields to fields in your database that have the same names.Data Manager Mapping Function Parameters Description *Str(string) Not applicable This function adds a text string to the members of a column. Example: Account=*Pad(Ac count.L.Condition2 then Action2.10.C." map using Action2 Default Action – If both Condition1 and Condition2 are "False".B.10. The padding character is optional and is a space by default.Default Action) Condition1 . Use in conjunction with the NONE delimiter." map using Action1 Condition2 . Example: Entity = *Str(NE) + *COL(1) *PAD (A. except that the field names contain extra characters (either before or after the name).0) *If (Condition1 then Ac tion1.If this evaluates to "True. Data Manager Mapping Function Parameters Description This function allows you to test a series of conditions. mapping function examples.52 AB. *str(YY)) If the sum of the product. and result sets to gain an understanding of how the *IF function can be used in various scenarios: Data Set 1: PRODUCT.ID. Example: • Product=*if (Prod uct+ID+Entity = *str(148552) then *str(MHarn).ID(1:1) = *str(C) then *str(XX) .85. Example: Examine the following series of data sets.CD.EF GH.IJ.ID(1:1) = 364 2013-09-04 . ID. and entity value are equal to 148552 then change product value to MHarn or • Else IF first value of ID field is equal to C then Change Product value to XX Note: The *STR() function must be used when evaluating numeric constants in an *IF statement. and to apply a corresponding action if the condition is true.KL Mapping Function 1: Product=*IF (prod uct+ID+Enti ty=*Str(148552) then *str(MHarn).ENTITY 14. CA03 ERR. SEntity U1000000. US01 Z2000A01.85. US01 A01.52 AB.1.1:1)=Z then *col(1. *STR(ERR)) Result Set 2: Entity. JP04 Mapping Function 2: Entity=*IF(*col(1. SEntity US01. CA03 K3430000.1:1)=U then SEnti ty.1.ID. *str(YY)) Result Set 1: PRODUCT.6.*col(1.KL Data Set 2: Entity.XX.IJ.ENTITY MHarn.3:6). Use the following syntax to associate a dimension with a conversion sheet: Dimension Name = [COMPANY]WorkbookName[!SheetName] Note: Items in brackets are optional.EF YY. 365 2013-09-04 . JP04 39.Data Manager Mapping Function Parameters Description *str(C) then *str(XX) .3 Transformation File: Conversion Section The *CONVERSION section of the transformation file defines which conversion sheet to use with which dimensions. 2 Sample Transformation File When copy or import data between models and need to map the dimensions that are different. you can create a transformation file to map the dimensions.xls is the name of the Account dimension conversion file. the system assumes the sheet name is Conversion. If a name is not specified.6. Use the Amount option to specify the conversion file to be used if you specify the ConverAmountWDim option in the *Options section. Workbookname SheetName [ COMPANY] If [COMPANY] is defined then the Data Manager tries to obtain the conversion file from the main company Data Manager folder. This allows you to use a formula to scale the input or output values. The following table contains a list of the dimensions in a sample source and target application: 366 2013-09-04 . Examples: Where AccountConv. Otherwise the Data Manager looks in the appropriate site folder.xls Use the Amount keyword with the ConvertAmountWDim transformation option Account = AccountConv. If [COMPANY] is defined then the Data Manager tries to obtain the conversion file from the main company Data Manager folder.1.xls!newaccount Account = [COMPANY]AccountConv.xls Amount = AccountConv.xls!newaccount 39. Account = AccountConv. The name of the conversion file This is the name of the worksheet to use within the conversion file. Otherwise the Data Manager looks in the appropriate Site folder.Data Manager The following table describes the variables: Variable Description DimensionName Either the dimension name to correlate with the conversion file or the keyword Amount. 2 Data Conversions 367 2013-09-04 .6. *OPTIONS FORMAT = DELIMITED HEADER = YES DELIMITER = SKIP = 0 SKIPF = CREDITNEGATIVE=NO CONVERTAMOUNTWDIM= MAXREJECTCOUNT= VALIDATERECORDS=YES *MAPPING cat=category Acc=Account Ent = Entity Tim=time Currency=Rptcurrency int=intco dat=Datasrc *CONVERSION 39.Data Manager Source Category Account Entity Time Rptcurrency Intco Datasrc Target Cat Acc Ent Tim Currency Int Dat The following is an example of a transformation file created to map dimensions from a source to a target application. 6. Open the conversion file then select Conversion Files >Validate and Process Conversion File. External ACCPAY Internal *skip • Wildcards 368 2013-09-04 . You create one conversion file per dimension in a transformation. 2. Select Conversion Files > Copy Conversion File. Validating. you can place the keyword *skip in the "lnternal" column. 2. • *skip If you want to ignore external data (as listed in the "External" column). Each conversion file can contain one or more sheets for different types of data transformations.Data Manager Conversion files define the mapping by dimensions from external member names to internal member names.6. 39. To copy a conversion file: 1. They also provide the ability to perform arithmetic and data decimal places during the conversion. locate the conversion file. then click Save.1 Creating. In the dialog box. locate the conversion file you want to copy.2. then click Save.2 Keywords and Wildcards Used in Data Conversions You can use the following values in data conversions. To validate a conversion file: 1. 39. In the dialog box. and Copying Conversion Files To create a conversion file: 1. Enter data as required. In the Data Manager select Conversion Files > New Conversion File. as in the following example.2. Recommendation: We recommend you give the conversion file the same name as the dimension for which it is being used. 2. This is useful when you are creating a transformation file and want to see a preview of the data presentation. You can preview data files that reside on the server in the Company site or other Site directories. Note: The system administrator can determine which files can be uploaded into Planning and Consolidation. You can preview Microsoft Access database (mdb). process chains.10 39. This would be useful to apply a formula to all members.Data Manager You can use the asterisk (*) and question mark (?) wildcards in the External or Internal columns.000 offer the best performance. An asterisk (*) stands for any character. Typically. use the asterisk (*).csv files from your local hard drive to the Data Manager Data Files folder on the server. You can set the size parameter in the process chain template to specify how many rows of data to transfer at a time. while a question mark (?) stands for any single character. For example. The Data Manager also allows you to preview your data files. in the case of the planning and consolidation application for NetWeaver.7 Data Transfer and Preview 39. The optimal value for this parameter depends on the SAP NetWeaver system and on additional processing of the data that might occur. if you want to reference all members. values between 2. The upload and download functions allow you to move flat files such as . Microsoft Excel. You also transfer data in and out of the planning and consolidation application using packages and. and ASCII text data files.000 and 20.1 About Data Transfer and Preview There are several options for transferring data in Data Manager.7.txt and . 369 2013-09-04 . The formula in the following example would increase all members by 10 percent: External * Internal * Formula Value*1. browse to locate the text file that you want to download. In the "Data Manager . select a table from the Select a table list. then click Download.7. 3.3 Previewing Data You can preview the first 200 lines of data. In the Data Manager click Download Data. then click Save. Click one of the following: • Upload • Download 39. perform one of the following actions: • For text files select a data type from the list: • Fixed width • Delimited Note: If you select delimited files.Data Manager 39.1. Select the file that you want to preview then click Open.Download" dialog box. In the Data Manager click Data Preview.7. 39. you must also select a delimiter. Click one of the following: • Upload Data • Download Data 2. 3. Browse to locate the flat file you want to upload or download. 2. 3. 370 2013-09-04 . 1. To preview data: 1. Depending on the type of file you opened.1 Uploading or Downloading Data To upload or download flat files to and from your local hard drive. select from the Select a worksheet list. • • For Microsoft Excel files. select the destination for the file.7. For database files.1. 2. In the next dialog box.2 Downloading a Text File from the Database To download a text file from the database: 1.1. click Cancel. 5. 371 2013-09-04 . Choose Cancel when you are done previewing your data. In the dialog box select a different file and click Open to preview another file.Data Manager 4. When you have finished previewing data. Click Open. 6. Data Manager 372 2013-09-04 . see EPMExecuteAPI. in the Microsoft Visual Basic window. by using the EPMExecuteAPI function. select Tools > References. See Custom VBA Functions (Events). select the Visual Basic button. In the dropdown list on the top. select FPMXLClient.1. select View > Object Browser. For more information.1 Macros 40. the EPM add-in APIs are not supported.1 Context 40.1 SetContextOptions 373 2013-09-04 . 40.1. Note: • • • You can customize your VBA code by associating events.1. Then.APIs APIs You can perform some tasks (such as reporting and input tasks or user interface actions) by using the provided APIs in Microsoft Visual Basic for Applications (VBA). Then. Select the FPMXLClient reference. • The IEPMExecuteAPI class exposes all the macros that you can execute directly from a worksheet cell. Any API that is not explained in this documentation is not supported. Note: These APIs are accessible via standard Microsoft Excel commands: in the Developer tab. In Microsoft Office Word and Powerpoint. In the list of classes: • The IEPMAutomation class contains the macros that can be executed for the EPM add-in (but cannot be used with the EPMExecuteAPI function). hide a dimension in the EPM Context bar. 374 2013-09-04 .APIs This API enables you to change the following context options: lock a dimension. Mandatory. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.APIs Parameter Description File as Object • Name of the Microsoft Excel workbook to which you want to apply the lock or hide • or name of the Microsoft Excel worksheet to which you want to apply the lock or hide • or name of the Microsoft Word document • or name of the Microsoft Powerpoint presentation Mandatory Connection. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. as it appears in the Connection Manager dialog box. • Dimension member name (caption or unique name) • or dimension:member. hideDimension Enter TRUE to hide the specified dimension in the EPM Context bar .1. • hierarchy:member for the other connections. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .1. enter FALSE to display the dimension in the EPM Context bar. Mandatory MemberName As String Name of the member you want to set for the locked dimension. See Types of Connections) • "[%connection name%]". 40. connectionString As String DimensionName As String Caption or unique name of the dimension you want to lock. Mandatory.2 SetContextOptionsForSeveralDimensions 375 2013-09-04 . 1. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . enter FALSE to display the dimension in the EPM Context bar.. 376 2013-09-04 .. to 29 Mandatory Dimension you want to lock and the member that you want to set for the locked dimension.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. dimension=member. Parameter Description File as Object • Name of the Microsoft Excel workbook to which you want to apply the lock or hide • or name of the Microsoft Excel worksheet to which you want to apply the lock or hide • or name of the Microsoft Word document • or name of the Microsoft Powerpoint presentation Mandatory Connection. where you specify the unique name for the dimension and for the member hideDimension1. hide a dimension in the EPM Context bar. See Types of Connections) • "[%connection name%]". to 29 Enter TRUE to hide the specified dimension in the EPM Context bar . as it appears in the Connection Manager dialog box. 40. connectionString As String DimensionMember1.APIs This API enables you to change the following context options for several dimensions: lock a dimension.1.3 AddContextFavorite This API enables you to create a new context favorite... Mandatory. where you specify the unique name for the dimension and for the member 40.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Mandatory.1. FavoriteName as string Mandatory Name of the favorite. 377 2013-09-04 . as it appears in the Connection Manager dialog box. context Mandatory The context is Visual Basic string array. See Types of Connections) • "[%connection name%]". Each string element uses the syntax dimension=member. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .APIs Parameter Description connectionString As String Connection.1.4 UpdateContextFavorite This API enables you to modify the context selection for a specific context favorite. Mandatory.APIs Parameter Description connectionString As String Connection.5 DeleteContextFavorite This API enables you to delete a context favorite. as it appears in the Connection Manager dialog box. 378 2013-09-04 . See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Each string element uses the syntax dimension=member.1.1. where you specify the unique name for the dimension and for the member 40. context Mandatory The context is Visual Basic string array. FavoriteName as string Mandatory Name of the favorite. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . FavoriteName as string Mandatory Name of the favorite.APIs Parameter Description connectionString As String Connection. 379 2013-09-04 .1.6 SelectContextFavorite This API enables you to select a context favorite in the EPM Context bar. See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 40.1. as it appears in the Connection Manager dialog box. Mandatory. 380 2013-09-04 . FavoriteName as string Mandatory Name of the favorite.1. See Types of Connections) • "[%connection name%]". Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .7 GetContextFavorite This API enables you to retrieve the dimension members for a specific context favorite. 40.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Mandatory. as it appears in the Connection Manager dialog box.1.APIs Parameter Description connectionString As String Connection. 381 2013-09-04 .oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.APIs Parameter Description connectionString As String Connection. 40. Mandatory.1. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . as it appears in the Connection Manager dialog box.2 SetDimensionCaption This API enables you to specify a customized name for a specific dimension. See Types of Connections) • "[%connection name%]". FavoriteName as string Mandatory Name of the favorite. 1 SetSheetOption This API enables you to specify an option that applies to the specified Microsoft Excel sheet. See Types of Connections) • "[%connection name%]". 382 2013-09-04 .1. Mandatory.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. as it appears in the Connection Manager dialog box.3 Options 40.1. 40. Specify the new name you want for the specified dimension. Microsoft Word document or Microsoft PowerPoint presentation. Specify FALSE if you do not want to update the interface. Mandatory. currentCaption As String newCaption As String refreshUI As Boolean Specify the dimension for which you want to modify the name. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Microsoft Excel workbook.APIs Parameter Description ConnectionString As String Connection. Mandatory. Specify TRUE to update the interface with the new name (the EPM Context bar and dimension tree view in the EPM pane and the Report Editor).3. Mandatory. Mandatory for options 30 and 31. Specify the option. or name of the Microsoft Word document. or name of the Microsoft Powerpoint presentation. Mandatory. Mandatory. Specify the password when protecting a worksheet or a workbook. Activate Member Recognition 2 Activate Local Member Recognition Not EPM Worksheet Totals on the left Totals at the top Remove empty rows 3 4 5 6 7 383 2013-09-04 . the "Hide empty rows" is automatically set to FALSE. Mandatory. See below the list of values available. See below the list of values available.APIs Parameter Description File as Object sheetOption sheetOptionValue password sheetProtectionOptions as Long Name of the Microsoft Excel worksheet. Specify only if you have specified 300 or 301 in the sheetOption parameter Here is the list of values corresponding to the sheet options: sheetOption Option Option sheetOptionValue Expand Options 0 Children 0 Member and 1 Children Descendants 2 Member and 3 Descendants Use as Input Form 1 TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE Note: If you specify TRUE. the "Remove empty columns" is automatically set to FALSE.APIs Option sheetOption Option sheetOptionValue Remove empty columns 8 TRUE or FALSE Note: If you specify TRUE. Hide empty columns 10 TRUE or FALSE Note: If you specify TRUE. Show as Excel Comment Use Position in Axis Row Header Indentation 11 12 100 No Identation Ident Children Ident Parents TRUE or FALSE TRUE or FALSE TRUE or FALSE 0 1 2 Display Name 101 Full Unique Name Caption 1 2 TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE (text that you want to be displayed) TRUE or FALSE Auto Fit Column Width Repeat Column Headers Repeat Row Headers Set Default Value in Empty Cell Empty Cell Default Value 102 103 104 105 106 Default Value when Member 107 not Found in Shared axis 384 2013-09-04 . the "Remove empty rows" is automatically set to FALSE. the "Hide empty columns" is automatically set to FALSE. Hide empty rows 9 TRUE or FALSE Note: If you specify TRUE. 15 ro values Remove empty rows and ze.202 chy Refresh Data in the Whole File When Opening it Clear Data in Whole File When Saving it 203 204 Show Unauthorized Cell Text 205 Apply only Report Editor 206 Definition for Faster Refresh Restore Dynamic Selection on Refresh after Navigation 207 385 2013-09-04 .APIs Option sheetOption Option sheetOptionValue Member not Found Default Value Apply Dynamic Formatting Formatting Sheet Name 108 109 110 (text that you want to be displayed) TRUE or FALSE (text that you want to be displayed) TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE TRUE or FALSE Clear Report Format Before 111 Applying Dynamic Formatting Hide empty rows and zero values 14 Hide empty columns and ze.16 ro values Remove empty columns and 17 zero values Keep Formula on Data Show Source Data in Comments 200 201 Calculate Parents in Hierar. but allowing to delete and insert columns Sub test() Dim api As Object Set api = Application.Connect"). You can unprotect a sheet using the Microsoft Excel feature or the EPM add-in feature.SetSheetOption Sheet1. SheetProtectionOptions End Sub where: • Sheet1 is the name of the sheet • 300 corresponds to the Protect Active Worksheet option 386 2013-09-04 . Example: Protecting a worksheet. the options will not be taken into account. except that they are all prefixed with ProtectSheet_. you must use the EPM add-in feature.COMAddIns("FPMXLClient. ProtectSheet_ProtectDefault. ProtectSheet_UserInterfaceOnly. to protect a sheet. If you do not use it. Note: The Microsoft Excel sheet protection always overrides the EPM add-in sheet protection. ProtectSheet_ProtectDrawingObjects.ProtectSheet_AllowColumn Delete + FPMXLClient. ProtectSheet_ProtectContents. "mypassword".APIs Option sheetOption Option sheetOptionValue Keep Formulas Static that Reference Report Cells Protect Active Worksheet 208 300 TRUE or FALSE TRUE or FALSE + enter the password in the password parameter. ProtectSheet_None. However. Optional: enter sheet protection options Protect Active WorkBook 301 TRUE or FALSE + enter the password in the password parameter Optional: enter sheet protection options The sheet protection options are the ones used in Microsoft Excel. For details about the options. Caution: • • • Enter: SheetProtectionOptions As Long Each option must be separated by the character + You must use ProtectSheet_ProtectContents to activate the protection. ProtectSheet_ProtectScenarios. ProtectSheet_AllowSorting. see the Microsoft Excel documentation.Object Dim SheetProtectionOptions As Long SheetProtectionOptions = FPMXLClient. ProtectSheet_AllowRowDelete.ProtectSheet_ProtectContents + FPMXLClient. Here is the list of options: ProtectSheet_AllowColumnDelete. ProtectSheet_AllowFormatCells. ProtectSheet_AllowFormatRows. ProtectSheet_AllowColumninsert. ProtectSheet_AllowFiltering.ProtectSheet_AllowColumnInsert api. ProtectSheet_AllowFormatColumns. True. ProtectSheet_AllowRowInsert. ProtectSheet_AllowHyperlinkInsert. ProtectSheet_AllowUsingPivotTables. 300. SetSheetOption Sheet1. Example: Activating the Auto Fit Colmun Width option Sub test() Dim api As Object Set api = Application.COMAddIns("FPMXLClient.APIs • • • TRUE activates the option the fourth parameter is where you enter a password in quotation marks SheetProtectionOptions: applies the options declared in the line above Example: Protecting a worksheet Sub test() Dim api As Object Set api = Application. 102.2 GetSheetOption 387 2013-09-04 .Object api.SetSheetOption Sheet1.COMAddIns("FPMXLClient.Connect"). 0.Object api.COMAddIns("FPMXLClient.Connect"). 2 End Sub where: • Sheet1 is the name of the sheet • 0 corresponds to the Expand Options • 2 corresponds to the Expand Descendants option. True End Sub where: • Sheet1 is the name of the sheet • 102 corresponds to the Auto Fit Column Width option • TRUE activates the option 40. True.1.SetSheetOption Sheet1. "mypassword" End Sub where: • Sheet1 is the name of the sheet • 300 corresponds to the Protect Active Worksheet option • TRUE activates the option • the fourth parameter is where you enter a password in quotation marks Example: Setting the option that expands descendants Sub test() Dim api As Object Set api = Application. 300.Connect").3.Object api. Mandatory. (no equivalent option in the EPM add-in interface) ActivateMem. You can define options that will apply to any use of the EPM add-in. Mandatory. see the EPM add-in Installation Guide. Specify the option. Mandatory. See the list of values corresponding to the sheet options in SetSheetOption. Parameter Description optionName as string Name of the option. Microsoft Excel workbook. See below the list of options available. or name of the Microsoft Powerpoint presentation.True or False berSetModeForFor more information on this option. newValue as object Specify the value for the option. Changes to this option will persist when Microsoft Office Excel. Microsoft Word document or Microsoft PowerPoint presentation.3 SetUserOption This API enables you to specify an option that applies to any use of the EPM add-in. see BaseLevel the EPM add-in Installation Guide. Mandatory. 40. Here is the list of values corresponding to the user options: optionName parameter newValue parameter Option Name and Path on the Interface ActivateMemberSetMode True or False For more information on this option.APIs This API enables you to return an option that applies to the specified Microsoft Excel sheet. AlwaysAutoUp. Parameter Description File as Object sheetOption Name of the Microsoft Excel worksheet. Word or PowerPoint is closed and reopened.1.3.True or False dateCharts AutomaticRefresh True or False (no equivalent option in the EPM add-in interface) User Options > Navigation > Refresh Charts Automatically User Options > Navigation > Automatic Refresh on Context Changes 388 2013-09-04 . See below the list of values available. or name of the Microsoft Word document. character string (no equivalent option in the EPM add-in lectionMethod interface) The last relationship the user has selected in the Member Selector for one or more selected members.True or False Typing User Options > Display > Collapse Dimension Tree View User Options > Others > Notify me when updates are available > Enable Manual Entry of Members ContextualSe.APIs optionName parameter newValue parameter Option Name and Path on the Interface AutoUpdateWarning BOEServer True or False character string User Options > Others > Notify me when updates are available User Options > Server Configuration > SAP BusinessObjects Enterprise Server Clear Metadata Cache Frequency data entry field in User Options > Navigation CacheValidityValues: integer Duration Default value: 0 Enter a number to specify the number of days CollapseTree.character string tyComment DisplayDepre.character string tionId DefaultForEmp.True or False viewByDefault ContextDirect. CreateStyleTrue or False ForUnrecognizedMembers DataLinkColor Values: integer Default value: 0 Use ARGB color values DefaultConnec.True or False catedFunctions DoNotStoreTrue or False ModelWarning Set as Default option in the Connection Manager User Options > Others > Empty Comment User Options > Others > Load EV Functions User Options > Navigation > Warn if Connection or Environment in the Connection is not Stored User Options > Display > Collapse Dimension Tree View > Apply Specific Formatting to Unrecognized Members Data Link Symbol Color button in User Options > Others 389 2013-09-04 . is taken into account. then Insert Members > Insert Position User Options > Navigation > Keep/Exclude on Single Member User Options > Others > Application Language KeepEliminate True or False LanguageEdition character string Values: ISO 639-1 language codes For example.APIs optionName parameter newValue parameter Option Name and Path on the Interface DoubleClick ExpandCollapse True or False True or False User Options > Navigation > Enable Double-Click User Options > Navigation > Expand/Collapse on Single Member User Options > Others > Force Symmetric Refresh for Large Asymmetric Axis User Options > Display > Collapse Dimension Tree View > Display Disaggregation Warning (no equivalent option in the EPM add-in interface) User Options > Others > Display Warning when Process Takes Time ForceSymetric. When set to False. the option is unchecked. en stands for English Lancharacter string guageIsoCode Values: ISO 639-1 language codes For example. User Options > Others > Display Warning when Saving Data or Comment > EPM InPlaceInsertPosition True or False EPM contextual menu.True or False QueryWhenNecessary HideDisaggre. HideSubmitWarning True or False Caution: • • When set to True. the option is unchecked. the option is checked.True or False gationWarning HideLinks HideRefreshWarning True or False True or False Caution: • • When set to True. en stands for English User Options > Navigation > Data Language 390 2013-09-04 . When set to False. the option is checked. ) is taken into account. all members. the destination worktion book opens in the same Microsoft Excel instance. base Level. 391 2013-09-04 .APIs optionName parameter newValue parameter Option Name and Path on the Interface LinkIsLocal MemberLinkColor True or False User Options > Others > Workbook Location Member Link Symbol Color button in User Options > Navigation Values: integer Default value: 0 Use ARGB color values MemberSelecValues: integer torPagingSize Default value: 1000 Enter the maximum number of members to display when expanding a node in the member selector NonContextualSelectionMethod character string The last relationship the user has selected in the Member Selector when no member is selected ( blank member. True or False User Options > Navigation > Members Displayed on Node Expansion in Member Selector (no equivalent option in the EPM add-in interface) OfflineUnprotected User Options > Others > Do not Protect Workbook User Options > Server Configuration > Default Folder for Local Open/Save cells entry area in User Options > Others OpenSaveRoot.True or False SameApplicaWhen set to True.character string Folder OversizeQueryLimit Values: integer Default value: 0 PasswordParameter character string User Options > Server Configuration > Options > Password Parameter User Options > Navigation > Freeze Data Refresh User Options > Server Configuration > SAP Portal (no equivalent option in the EPM add-in interface) PauseRefresh True or False PortalAdress character string QuickLinkInThe. etc. True or False Method SendDataOnN.True or False nections ShowReportEdi.True or False tionPane ShowUnrecog.True or False odes ShowCurrentViewPane ShowCurrentViewVertical True or False True or False User Options > Others > Refresh only Data on "Save & Refresh Data" User Options > Navigation > Refresh only Expanded and Inserted Members User Options > Others > Remove EPM Worksheets Before Generation EPM contextual menu.True or False sheetBeforeGeneration ReplaceInsert.True or False DataAfterSubmit RefreshOnlyEx.True or False pandedMembers RemoveWork. then Insert Members > Insert Method User Options > Others > Send Parent Data to the Server on "Save Data" User Options > Others > Display EPM Context Bar User Options > Others > Display Context inside EPM Pane User Options > Others > Display Local Connections User Options > Others > Display EPM Pane User Options > Navigation > Warn if Rows and Columns of Unrecognized Members Will be Kept User Options > Server Configuration > Server Address User Options > Server Configuration > Authentication Type ShowLocalCon.True or False tionEnableSsl SmtpConfigura.True or False nizedMemberWarning SmtpConfigura.character string tionPassword User Options > Server Configuration > Enable SSL User Options > Server Configuration > Password 392 2013-09-04 .character string tionAddress SmtpConfiguraValues: tionAuthentica• enter 0 for Anonymous tionType • enter 1 for Basic • enter 2 for NTLM SmtpConfigura.APIs optionName parameter newValue parameter Option Name and Path on the Interface RefreshOnly. character string tionUser UnauthorizedCellsText character string Values: text Enter the text to display in cells containing data that you are not authorized to view. Default value: #Unauthorized Unrecognized.True or False orationAll VisibilityDataAnalysisAll True or False 393 2013-09-04 .APIs optionName parameter newValue parameter Option Name and Path on the Interface SmtpConfigura.True or False berIDInEVFomulas UseEPMStyle.True or False ityDuration UseCustomValues: integer DataLinkColor Default value: 0 Use ARGB color values UseCustomMemberLinkColor True or False User Options > Server Configuration > Server Port User Options > Server Configuration > User Name User Options > Others > Unauthorized Cell Text User Options > Navigation > Keep Rows and Columns of Unrecognized Members User Options > Navigation > Clear Metadata Cache Frequency Data Link Symbol Color button in User Options > Others User Options > Others > Member Link Symbol Color User Options > Others > Use EPMMemberID in EPM Formulas User Options > Display > Apply Specific Formatting to Large Key Figure User Options > Navigation > Activate Metadata Cache User Options > Server Configuration > Options > User Name Parameter Command Display Options > Collaboration Group > All Buttons Command Display Options > Data Analysis Group > All Buttons UseEPMMem.character string rameter VisibilityCollab.True or False MemberManagement UseCacheValid.True or False Cache UserNamePa.True or False LargeKeyFigure UseMetaData.character string tionPort SmtpConfigura. 3.True or False tAndAnalysisOpenSave VisibilitySubmit.4 Report Connections 394 2013-09-04 .True or False DataAll VisibilityToolsCustomMembers VisibilityToolsOfflineMode VisibilityToolsQuickLinks VisibilityUndo True or False True or False True or False True or False WarmDynami. Mandatory.True or False cRefresh WarnIfQueryIs. See the list of values corresponding to the user options in SetUserOption.APIs optionName parameter newValue parameter Option Name and Path on the Interface VisibilityDataManager True or False Command Display Options > Data Manager Group > All Buttons Command Display Options > Reports Group > Open/Save Command Display Options > Data Input Group > All Buttons Command Display Options > Tools Group > Custom Members Command Display Options > Tools Group > Offline Mode Command Display Options > Tools Group > Quick Links Command Display Options > Undo Group > All Buttons User Options > Navigation > Warn if Navigation Will Break Dynamic Selection User Options > Others > Warn if Report Exceeds VisibilityRepor.True or False TooBig 40.1. 40. Parameter Description optionName as a string Name of the option.4 GetUserOption This API enables you to return an option that applies to any use of the EPM add-in.1. See Types of Connections) • "[%connection name%]".1 Connect This API enables you to connect an existing connection to a cube or model. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Login As String Password As String Login to the connection. Parameter Description ConnectionString As String Connection. 395 2013-09-04 . Optional Password to the connection.1.4. as it appears in the Connection Manager dialog box. Optional.2 ConnectAllReports This API enables you to connect all the reports of the workbook at once.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.1.1. Mandatory. Optional. Parameter Description Login As String Password As String Login to a connection. Password to a connection.3 ChangeReportConnection This API enables you to connect a report to another connection (the connection must already be connected). Optional 40.APIs 40.4. 40.4. 1.4.4.5 GetConnections This API returns the list of the connections for the specified worksheet.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. See Types of Connections) • "[%connection name%]".APIs Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. Mandatory. ReportID as string ConnectionString As String Identifier of the report. Mandatory. Mandatory. Parameter Description Worksheet as sheet Microsoft Excel worksheet name.1. The current connection is the one displayed in the Connected to area of the EPM Pane. 40. Mandatory.4 RefreshConnectionMetadata This API enables you to refesh the metadata for the data source used in the current connection. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 40. 396 2013-09-04 . 40.4. Example: "002" Connection.6 GetActiveConnection This API returns the active connection for the specified Microsoft Excel worksheet. This prevents you from logging off and then logging on again. No parameter. as it appears in the Connection Manager dialog box.1. for a specific file.1.4.4. Parameter Description File as Object connectionString As String Name of the Microsoft Excel worksheet or name of the Microsoft Word document or name of the Microsoft PowerPoint presentation. See Types of Connections) • "[%connection name%]".8 SetStaticActiveConnection This API enables you to set the active connection that will be taken into account for each worksheet or workbook that is opened. rather only via this API. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Mandatory. 40.7 SetActiveConnection This API enables you to select a connection as the active connection. Note: You cannot specify this connection from the user interface.APIs Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. as it appears in the Connection Manager dialog box. Connection. 40. 397 2013-09-04 . Mandatory.1. See Types of Connections) • "[%connection name%]". Set to FALSE to define the connection only as the active connection (same as with the SetActiveConnection API. isStatic Set to TRUE to define the connection that will be taken into account for each worksheet or workbook that is opened.1.) 40.APIs Parameter Description File as Object connectionString As String Name of the Microsoft Excel worksheet or name of the Microsoft Word document or name of the Microsoft PowerPoint presentation.9 SetActiveConnectionForOpenedFiles This API enables you to select a connection as the active connection for all files that are currently open: all open Microsoft Excel workbooks. as it appears in the Connection Manager dialog box. Mandatory.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. or all Microsoft PowerPoint presentations. See SetActiveConnection . Connection.4. 398 2013-09-04 . or all open Microsoft Word documents. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 399 2013-09-04 . as it appears in the Connection Manager dialog box.APIs Parameter Description connectionString As String Connection.1 CreateReport This API enables you to create a report with one member in the row axis and one member in column axis.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.5. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . See Types of Connections) • "[%connection name%]". 40.5 Reports 40.1.1. Mandatory. ColumnMemberDynamicRela. Mandatory. Mandatory. ReportName as string ColumnMemberName as string Report Name.APIs Parameter Description Worksheet as sheet ConnectionString As String Microsoft Excel worksheet name containing the report. • hierarchy:member for the other connections. Mandatory Connection.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. See Types of Connections) • "[%connection name%]". where you can specify either the caption or unique name for the hierarchy and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections.See below the list of values available. Specify the member for the column axis. Mandatory. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . • Dimension member name (caption or unique name) • or dimension:member. tion as integer 400 2013-09-04 . as it appears in the Connection Manager dialog box. Mandatory. 2 SetDisplayName This API sets the members names to display as alternatives to the captions for the specified dimension. Mandatory. List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 • Member and Ascendants = 10 • Member and Leaves = 11 • Property = 12 • Named Set = 13 • Member OffSet = 14 • Member Property = 15 40. Optional. where you can specify either the caption or unique name for the hierarchy and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections.1. Mandatory.APIs Parameter Description RowMemberName as string Specify the member for the row axis. RowMemberDynamicRelation See below the list of values available. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. • Dimension member name (caption or unique name) • or dimension:member.5. as integer StartRange as range Starting Microsoft Excel cell for the report. • hierarchy:member for the other connections. 401 2013-09-04 . Mandatory • • For local and SAP BusinessObjects connections. enter one of the names that are available in the drop-down menu in the Member Selector.1. Member Name to Display.APIs Parameter Description ReportD as string dimensionName as string DisplayName Identifier of the report. For Planning and Consolidation connections. the current worksheet is taken into account. Mandatory. 40. Optional.5. description. 402 2013-09-04 . Note: The text entered in this parameter is not case-sensitive. If not specified. Worksheet as sheet Excel worksheet name containing the report. See.description. enter one of the following names: ID.3 AddMemberToRowAxis This API enables you to add the specified dimension member (and its dimension if it is not already set) or to replace the dimension member (if the specified dimension is already set) in the row axis of the specified report. Dimension caption or unique name. ID . Mandatory.5. • Dimension member name (caption or unique name) • or dimension:member.4 RemoveMemberFromRowAxis 403 2013-09-04 . DynamicRelation as See below the list of values available. integer List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 • Member and Ascendants = 10 • Member and Leaves = 11 • Property = 12 • Named Set = 13 • Member OffSet = 14 • Member Property = 15 Note: The refresh action is required to update the report. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. 40.1. Mandatory. Mandatory.APIs Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. Example: "002" Mandatory. ReportID as string MemberName as string Identifier of the report. • hierarchy:member for the other connections. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. • Dimension member name (caption or unique name) • or dimension:member. Identifier of the report.APIs This API enables you to remove the specified dimension member (and its dimension if it is the only member for this dimension in the report) from the row axis. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. Mandatory.See below the list of values available. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. teger Applies only to dimension members that have been selected with the same dynamic relation. Mandatory. List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 • Member and Ascendants = 10 • Member and Leaves = 11 • Property = 12 • Named Set = 13 • Member OffSet = 14 • Member Property = 15 Note: The refresh action is required to update the report. MemberName as string Mandatory. DynamicRelation as in. • hierarchy:member for the other connections. 404 2013-09-04 . Mandatory. 5. Identifier of the report. 40. 40. 40. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report.5. Mandatory. Mandatory.APIs 40. Identifier of the report. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report.5 GetRowAxisDimensionCount This API returns the number of dimensions in the row axis of the specified report.1. Identifier of the report. Mandatory.8 AddMemberToColumnAxis 405 2013-09-04 . Mandatory.5.5.1.1. Mandatory.7 GetRowAxisOwner This API returns the ID of the report that is the owner of the row axis for the specified report. Mandatory. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report.1.6 GetRowAxisMembers This API returns the list of the dimension members of the row axis for the specified report. 2 406 2013-09-04 . • Dimension member name (caption or unique name) • or dimension:member.AddMemberToColumnAxis Sheet1.COMAddIns("FPMXLClient. where you can specify either the caption or unique name for the dimension and for the member Note: we recommend that you use: • dimension:member for Planning and Consolidation connections.APIs This API enables you to add the specified dimension member (and its dimension if it is not already set) or to replace the dimension member (if the specified dimension is already set) in the column axis of the specified report. • hierarchy:member for the other connections.Connect"). Mandatory. Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. Mandatory. Example: "002" Mandatory.Object client. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. "Australia". DynamicRelation as See below the list of values available. integer List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 • Member and Ascendants = 10 • Member and Leaves = 11 • Property = 12 • Named Set = 13 • Member OffSet = 14 • Member Property = 15 Example: Option Explicit Sub Example() Dim client As Object Set client = Application. Mandatory. "000". ReportID as string MemberName as string Identifier of the report. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections.5. DynamicRelation as in. List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 407 2013-09-04 . Identifier of the report. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. Mandatory. • hierarchy:member for the other connections.See below the list of values available. 40. teger Applies only to dimension members that have been selected with the same dynamic relation. Mandatory.9 RemoveMemberFromColumnAxis This API enables you to remove the specified dimension member (and its dimension if it is the only member for this dimension in the report) from the column axis. MemberName as string Mandatory. • Dimension member name (caption or unique name) • or dimension:member.APIs End Sub Note: The refresh action is required to update the report.1. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. Mandatory. Mandatory.5. 408 2013-09-04 . 40.1. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. Identifier of the report.5.11 GetColumnAxisMembers This API returns the list of the dimension members of the column axis for the specified report. Mandatory.APIs • • • • • • Member and Ascendants = 10 Member and Leaves = 11 Property = 12 Named Set = 13 Member OffSet = 14 Member Property = 15 Note: The refresh action is required to update the report. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report.1. 40. 40. Identifier of the report. Mandatory. Mandatory.12 GetColumnAxisOwner This API returns the ID of the report that is the owner of the column axis for the specified report.5.1.10 GetColumnAxisDimensionCount This API returns the number of dimensions in the column axis of the specified report. Mandatory.13 AddMemberToPageAxis This API enables you to add the specified dimension member (and its dimension if it is not already set) in the page axis of the specified report. DynamicRelation as See below the list of values available. Example: "002" Mandatory. Mandatory. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections.1.APIs Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. ReportID as string MemberName as string Identifier of the report. • Dimension member name (caption or unique name) • or dimension:member. integer List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 • Same Level = 7 • Siblings = 8 • Ascendants = 9 • Member and Ascendants = 10 409 2013-09-04 .5. • hierarchy:member for the other connections. 40. Mandatory. Mandatory. Identifier of the report. Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. Mandatory. 5. • hierarchy:member for the other connections. DynamicRelation as in. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report.See below the list of values available. 40. MemberName as string Mandatory. Mandatory.1. teger Applies only to dimension members that have been selected with the same dynamic relation. Mandatory. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member.14 RemoveMemberFromPageAxis This API enables you to remove the specified dimension member (and its dimension) from the page axis. List of supported dynamic relations values: • Member = 1 • Children = 2 • Member and Children = 3 • Descendants = 4 • Member and Descendants = 5 • Leaves = 6 410 2013-09-04 . • Dimension member name (caption or unique name) • or dimension:member. Identifier of the report.APIs • • • • • Member and Leaves = 11 Property = 12 Named Set = 13 Member OffSet = 14 Member Property = 15 Note: The refresh action is required to update the report. Mandatory. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. 1.15 GetPageAxisMembers This API returns the list of the dimension members of the page axis for the specified report.APIs • • • • • • • • • Same Level = 7 Siblings = 8 Ascendants = 9 Member and Ascendants = 10 Member and Leaves = 11 Property = 12 Named Set = 13 Member OffSet = 14 Member Property = 15 Note: The refresh action is required to update the report.1.5. Identifier of the report.5. Parameter Description Worksheet as sheet ReportID as string Microsoft Excel worksheet name containing the report.16 GetUnrecognizedMembers This API returns the list of the dimension members that are used in the specified report but that are not recognized in the cube or model. Mandatory. Mandatory. 40. 411 2013-09-04 . 40. 412 2013-09-04 . returnType Type of information returned for the unrecognized members. Mandatory.18 OpenMemberSelector This API opens the Member Selector that enables you to select members for a specified dimension and a specified connection.APIs Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report.1. 3 to return the unique name of members. Enter 1 to return the member captions. 40. Mandatory. Identifier of the report.1. Mandatory. 40. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. 2 to return the Microsoft Excel cells (B6 for example).5.17 GetPageAxisOwner This API returns the ID of the report that is the owner of the page axis for the specified report. ReportID as string Identifier of the report. Mandatory.5. Optional. as it appears in the Connection Manager dialog box. The specified members will be already selected in the Member Selector when it opens. 413 2013-09-04 .19 GetActiveReportName This API returns the name of the active report of the specified Microsoft Excel worksheet.APIs Parameter Description ConnectionString as String Connection.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.5. • Dimension member name (caption or unique name) • or dimension:member. dimensionName as String selectedMembers as String Caption or unique name of the dimension you want to select members for. 40. See Types of Connections) • "[%connection name%]". Name of the members you want to select. Mandatory.1. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. • hierarchy:member for the other connections. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. optional. The entered members will be already selected in the Member Selector when it opens. Mandatory. Mandatory.1. 40. Parameter Description Worksheet as sheet Microsoft Excel worksheet name.5. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. Mandatory. 40. Identifier of the report. 414 2013-09-04 .1.22 GetDataTopLeftCell This API returns the top-left Microsoft Excel cell of the data range of the specified report. Mandatory.21 GetDataBottomRightCell This API returns the bottom-right Microsoft Excel cell of the data range of the specified report.20 GetAllReportNames This API returns the name of all reports for the specified Microsoft Excel worksheet.5. Mandatory.APIs Parameter Description Worksheet as sheet Microsoft Excel worksheet name.1. 40.5. 23 GetShift This API returns the shift value between the report data range and the row or column axis of the specified report.5. Mandatory. Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. Mandatory. Value as integer Shift value. The "false" value returns the shift value for the column axis. 415 2013-09-04 . Mandatory. Parameter Description Worksheet as sheet Microsoft Excel worksheet name containing the report. The "false" value returns the shift value for the column axis.5. Mandatory. • • The "true" value returns the shift value for the row axis. Identifier of the report. 40.1. Note: The refresh action is required to update the report. ReportD as string IsRow as boolean Identifier of the report.1. 40.24 SetShift This API sets the shift value between the report data range and the row or column axis of the specified report. Mandatory. Mandatory. • • The "true" value returns the shift value for the row axis.APIs Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. ReportD as string IsRow as boolean Identifier of the report. 40. 416 2013-09-04 . where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections.7 SearchMember Applies to: Local connections.1. MemberName As String Mandatory.APIs 40. See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.1.6 GetMemberDimension This API returns the dimension of the specified dimension member. • hierarchy:member for the other connections. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. • Dimension member name (caption or unique name) • or dimension:member. Mandatory. Note: This API is available for benchmark purposes. This API simulates a member search in the Member Selector and enables you to return a list of members that corresponds to the specified text. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Parameter Description ConnectionString As String Connection. as it appears in the Connection Manager dialog box. Example: 1000 To use only if the propertyForSearch parameter value is 1. 1 for Like 0 to perform the search on the ID. Connection. Note: This API is available for benchmark purposes. Example: 0 Last page number. as it appears in the Connection Manager dialog box.APIs Parameter Description memberID searchOption propertyForSearch dimensionName hierarchyName from to tryOnKeyIfNotFound ConnectionString As String Text of a member to search for. 0 for Equals. returnID TRUE if you want to return the IDs of the members.1.8 GetChildrenFromMember Applies to: Local connections. See Types of Connections) • "[%connection name%]". 417 2013-09-04 .oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. The search will be performed on the ID. Mandatory. This API simulates the navigation in the Member Selector and enables you to return a list of members that corresponds to the children of a specified member. FALSE if you want to return the captions of the members 40. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 1 to perform the search on the caption ID or name of the dimension ID or name of the hierarchy First page number. 418 2013-09-04 . FALSE if you want to return the captions of the members 40. Mandatory. ID of the hierarchy First page number. Example: 1000 Connection. as it appears in the Connection Manager dialog box.APIs Parameter Description memberID hierarchyName from to ConnectionString As String ID of the member for which you want to return the children. See Types of Connections) • "[%connection name%]".9 GetMemberHierarchy This API returns the hierarchy of the specified dimension member.1. returnID TRUE if you want to return the IDs of the members.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Example: 0 Last page number. APIs Parameter Description ConnectionString As String Connection. 40. • hierarchy:member for the other connections. where you can specify either the caption or unique name for the dimension and for the member Note: It is recommended that you use: • dimension:member for Planning and Consolidation connections. 419 2013-09-04 . • Dimension member name (caption or unique name) • or dimension:member.1. Mandatory.10 GetDimensionList This API returns the list of all dimensions for the specified connection. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . MemberName As String Mandatory. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member. as it appears in the Connection Manager dialog box. See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Mandatory. See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.1. 40. as it appears in the Connection Manager dialog box. as it appears in the Connection Manager dialog box. 40.12 GetHierarchyMembers This API returns the list of all dimension members for the specified dimension.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . See Types of Connections) • "[%connection name%]".1. Mandatory. 420 2013-09-04 . Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .11 GetHierarchyList This API returns the list of all hierarchies for the specified connection. Parameter Description ConnectionString As String Connection.APIs Parameter Description ConnectionString As String Connection. as it appears in the Connection Manager dialog box. See Types of Connections) • "[%connection name%]". HierarchyName As String Hierarchy caption or hierarchy unique name.1 SetActiveBooksConnection 421 2013-09-04 . Note: For Planning and Consolidation connections. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Identifier of the report.1.APIs Parameter Description ConnectionString As String Connection.13 Get MDX Request Applies to: Local or SAP BusinessObjects Enterprise connections.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. 40. 40. Parameter Description Worksheet as sheet ReportD as string Microsoft Excel worksheet name containing the report. Mandatory.14 Book Publication and Distribution 40. This API returns the MDX request performed by the EPM add-in against an ODBO data source.14. it is recommended that you specify the hierarchy unique name containing the dimension name. Mandatory. Mandatory.1.1. 2 GetActiveBooksConnection This API returns the current connection on which publication and distribution actions are performed.14.1.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.APIs This API enables you to connect to the connection on which publication and distribution actions are performed. as it appears in the Connection Manager dialog box.14. Mandatory. 422 2013-09-04 . then selects the book publication template. No parameter.14. Parameter Description ConnectionString As String Connection.3 OpenDistributionWizardOnSpecificTemplate This API selects the specified distribution template. 40. 40. Mandatory.4 OpenBookPublicationWizardOnSpecificTemplate This API selects the specified server folder ("Public" or a team).1. and opens the book publication wizard with this selection.1. See Types of Connections) • "[%connection name%]". Parameter Description FileName as string Microsoft Excel distribution template. 40. and opens the distribution wizard. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 1.APIs Parameter Description FileName as string TeamId as string Book publication template.15. No parameter. Here is how the ExpandActiveSheet API is executed: Before_expand() Expand() After_Expand() Before_refresh() Refresh() After_Refresh() Here is how the ExpandActiveSheetExpandEventsOnly API is executed: Before_expand() Expand() Refresh() After_Expand() 40. Mandatory.1. Blank value for "Public" folder or the team name.1. 423 2013-09-04 .15 EvDREs 40. Mandatory. 40. No parameter.1 ExpandActiveSheet and ExpandActiveSheetExpandEventsOnly These APIs enable you to expand data and metadata only for the active sheet that contains EVDRE.2 ExpandActiveWorkBook This API enables you to expand data and metadata for all the sheets containing EVDRE in the active workbook.15. APIs 40.1. This API returns the current connection on which the EvDRE migration is performed.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. No parameter.2 GetActiveMigrationConnection Applies to: Planning and Consolidation connections.1.15. See Types of Connections) • "[%connection name%]". Related Topics • Launching the EvDRE Migration 40. Related Topics • Launching the EvDRE Migration 424 2013-09-04 .3 EvDRE Migration 40.3. This API enables you to connect to the connection on which the EvDRE migration is performed.1 SetActiveMigrationConnection Applies to: Planning and Consolidation connections.15. as it appears in the Connection Manager dialog box.1.15. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . Parameter Description ConnectionString As String Connection. Mandatory.3. APIs 40.2 GetActiveFileManagementConnection Applies to: Planning and Consolidation connections.16. This API enables you to connect to the connection on which the Open and Save actions are performed. as it appears in the Connection Manager dialog box. See Types of Connections) • "[%connection name%]". Related Topics • Open and Save Connection 40.16.16 Open/Save Connections 40.1.1. No parameter.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 425 2013-09-04 . Parameter Description ConnectionString As String Connection. This API returns the current connection on which the Open and Save actions are performed. Mandatory.1.1 SetActiveFileManagementConnection Applies to: Planning and Consolidation connections. 1.17.2 Macros used in EPMExecuteAPI function 426 2013-09-04 . Mandatory. 40.17 Data Manager Connections 40. as it appears in the Connection Manager dialog box.1.2 SetActiveDataManagerConnection(string connectionString) This API enables you to connect to the connection on which Data Manager actions will be performed. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . 40. Parameter Description ConnectionString As String Connection.1 GetActiveDataManagerConnection() This API returns the current connection on which Data Manager actions are performed.17.1.APIs Related Topics • Open and Save Connection 40. See Types of Connections) • "[%connection name%]".oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. No parameter. 1 LogOn This API opens the Logon dialog box. you must specify EPMExecuteAPI before the name of the API you want to execute.APIs For all APIs listed in this section. 40. etc: all the parameters needed for the macro.Run.2 Connections 40. Arg2.2. see EPMExecuteAPI. 40.2 CloseConnection This API enables you to disconnect a specific connection. You can simply not mention the displayedText value in the case where there is no parameter after. No parameter. Arg1. • Arg1.1 OpenConnectionManager This API opens the Connection Manager dialog box. DisplayedText. 40.2. For more information on the EPMExecuteAPI function. 427 2013-09-04 .2. No parameter. this parameter is not used and you can leave it empty (see the example below).2.2.2. The general syntax is the following: EPMExecuteAPI(APIName. Arg2 …) • APIName: DataManagerRunPackage for example • DisplayedText: when launched from Application. as it appears in the Connection Manager dialog box. that is if the connection is connected or not. An offline workbook can be read by any user.2.2.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. See Types of Connections) • "[%connection name%]". Parameter Description ConnectionString as String Connection. 40. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .APIs Parameter Description ConnectionString as String Connection. even the users that do not have the EPM add-in installed. See Types of Connections) • "[%connection name%]".2. No parameter.3 GetConnectionStatus This API gets the status of a specified connection. 40. as it appears in the Connection Manager dialog box. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .2.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.4 GoOffline This API makes the current workbook an offline workbook. Mandatory. 428 2013-09-04 . Mandatory. 2. No parameter.2.2.2.2.2.3.5 GoOnline This API makes the current offline workbook an online workbook. 429 2013-09-04 .APIs 40.2. No parameter. Parameter Description filePath As String Path (including the file name) to the Excel file to open.1 OpenExcelWorkbook This API opens a specified Microsoft Office Excel workbook. 40.3.3 Excel 40.6 Logoff This API disconnects all the connections used in the current workbook. An online workbook can only be read by users that have the EPM add-in installed.2 CloseExcel This API closes the current Microsoft Office Excel instance. 40. No parameter. 40. 2.4 OpenWordDocument This API opens a specified Microsoft Office Word document. 40.2 OpenPowerPointPresentation This API opens a specified Microsoft Office PowerPoint presentation.4 Word and PowerPoint 40. Parameter Description filePath As String Path (including the file name) to the PowerPoint file to open. 40.2.4.2. 430 2013-09-04 .1 LaunchPowerPoint This API launches a Microsoft Office PowerPoint instance.4.4. No parameter. No parameter.4.3 LaunchWord This API launches a Microsoft Office Word instance. 40.2.APIs 40.2. 40. 40. 40.5. 40. No parameter.2. 431 2013-09-04 .2.1 Back This API performs a Back.4. It will undo the last EPM add-in navigation operation.APIs Parameter Description filePath As String Path (including the file name) to the Word file to open.2.2. No parameter.5 OpenInsertDataDialog This API opens the Insert Data dialog box.3 CollapseMember This API enables you to perform a collapse on a specified member.5.5 Navigation 40.2 Collapse This API enables you to perform a collapse on the current cell.2. No parameter.5. for the current connection.6. This API displays information from an external database or the Journals database.5.5 ExpandMember This API enables you to perform an expand on a specified member. 40.4 Expand This API enables you to perform an expand on the current cell. Parameter Description cellRef As String cell reference containing the member to expand. No parameter is needed.6 Drill Through 40.APIs Parameter Description cellRef As String cell reference containing the member to collapse.2.2. 40.5. 40.2.1 DrillThrough Applies to: Planning and Consolidation connections. 432 2013-09-04 . No parameter.2. No parameter.7.1 GetContextMember This API returns the unique name of the context member of the specified dimension. This API displays information in a web browser for any URL.APIs 40. 40.7 Context Members 40.6.2.2 DrillThroughToURL Applies to: Planning and Consolidation connections.2.2. 433 2013-09-04 . for the current connection. 40. 434 2013-09-04 . DimensionName As String Dimension caption. as it appears in the Connection Manager dialog box.2 SetContextMember This API enables you to change the context member for the specified dimension.2.APIs Parameter Description ConnectionString As String Connection. Mandatory. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .7.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder. Mandatory. See Types of Connections) • "[%connection name%]". • hierarchy:member for the other connections.2. where you can specify either the caption or unique name for the dimension and for the member • or hierarchy:member.APIs Parameter Description connectionString As String Connection. Mandatory. where you can specify either the caption or unique name for the dimension and for the member Note: we recommend that you use: • dimension:member for Planning and Consolidation connections. 435 2013-09-04 . See Types of Connections) • "[%connection name%]". Mandatory. as it appears in the Connection Manager dialog box.7. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . MemberName As String Name of the member you want to specify as the context member. 40. • Dimension member name (caption or unique name) • or dimension:member.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.3 SetContextMembers This API enables you to change the context member for several specified dimensions. DimensionName As String Dimension caption or unique name. as it appears in the Connection Manager dialog box.8 Comments 40. where you specify the unique name for the dimension and for the member 40. 40.8.2 OpenFindCommentsEditor This API opens the Find Comments dialog box. No parameter.2. No parameter. Mandatory.2.APIs Parameter Description connectionString As String Connection. DimensionMember1 to Dimension and the member that you want to specify as the context member.2. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without .oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.8. 29 dimension=member. See Types of Connections) • "[%connection name%]".1 OpenAddCommentEditor This API opens the Add Comment dialog box. 436 2013-09-04 . 9.9 Open/Save from Server 40.2.9. No parameter. No parameter. 40.2.APIs 40. 40.9. This API opens the file selection dialog box on the server folder dedicated to reports.2. 40.4 SaveToServerRootFolder 437 2013-09-04 .9.3 OpenServerRootFolder Applies to: Planning and Consolidation connections. This API opens the file selection dialog box on the server folder dedicated to input forms.2.2.2 OpenServerReportFolder Applies to: Planning and Consolidation connections. No parameter. This API opens the file selection dialog box on the server root folder.1 OpenServerInputFormFolder Applies to: Planning and Consolidation connections. 2.12 Options 438 2013-09-04 .10 OpenDimensionAndMemberSelector This API opens the dialog box that enables you to select a dimension and a member for a specified connection. Mandatory. as it appears in the Connection Manager dialog box. 40.APIs Applies to: Planning and Consolidation connections. Parameter Description ConnectionString as String Connection. This API opens the dialog box that enables to save a file to the server.2.2. 40. See Types of Connections) • "[%connection name%]". 40. No parameter.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.11 OpenReportEditor This API opens the Report Editor dialog box. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . No parameter. Note: the selection of one dimension and one member only will be taken into account. • the active document. No parameter. for Microsoft Office Word. 40.1 OpenUserOptions This API opens the User Options dialog box. No parameter.2. No parameter.12.13 Refresh 40. for Microsoft Office PowerPoint.2.APIs 40.13.1 Refresh This API performs a refresh on: • the active report.2 OpenSheetOptions This API opens the Sheet Options dialog box. No parameter.2. • the active presentation. for Microsoft Office Excel.12.12. 439 2013-09-04 .2.2.3 OpenContextOptions This API opens the Context Options dialog box. 40. 40. 3 RefreshActiveReport This API performs a refresh on the active report.4 RefreshActiveSheet This API performs a refresh on: • the active worksheet. for Microsoft Office Word. No parameter. No parameter. 40. for Microsoft Office PowerPoint.5 RefreshActiveWorkBook This API performs a refresh on the active workbook.2 RefreshReportDataOnly This API performs a refresh only on the data for all the reports in the worksheet. 40. 40. • the active document.13.APIs 40. 40.2.2. except the data for local members.2.13.13. No parameter. • the active presentation.13. No parameter.2. for Microsoft Office Excel.14 Save Data 440 2013-09-04 .2. No parameter. No parameter. No parameter.14.14. 40.APIs 40.2.2. This API performs a save on the worksheet data. 40. 40. This API performs a save and a refresh on the workbook data. This API performs a save on the workbook data.2.2 SaveWorkbookData Applies to: Planning and Consolidation connections.14.3 SaveAndRefreshWorksheetData Applies to: Planning and Consolidation connections. No parameter.1 SaveWorksheetData Applies to: Planning and Consolidation connections.14. 441 2013-09-04 .4 SaveAndRefreshWorkbookData Applies to: Planning and Consolidation connections. This API performs a save and a refresh on the worksheet data.2. 1 Spread Applies to: Planning and Consolidation connections.3 Weight 442 2013-09-04 . No parameter. No parameter. 40. 40.2 Trend Applies to: Planning and Consolidation connections.2.2.16.2. This API opens the Change Work Status dialog box.16.2. This API opens the Trend dialog box. No parameter. This API opens the Spread dialog box.15 OpenWorkStatusEditor Applies to: Planning and Consolidation connections.16.2.APIs 40.16 Planning 40. 40. 2. 40. 40.APIs Applies to: Planning and Consolidation connections. No parameter.2.2.17.3 ValidateBookPublicationTemplate Applies to: Planning and Consolidation connections.17 Book Publication 40.17.4 SaveAsBookPublicationTemplate 443 2013-09-04 . This API opens the Weight dialog box. No parameter.1 CreateBookPublicationTemplate This API opens the Book Publication Template dialog box. This API validates the active book publication template. 40. No parameter.2.17.17.2. No parameter.2 OpenBookPublicationTemplate This API opens the dialog box that enables to select an existing book publication template. 40. 6 OpenBookPublicationWizard This API opens the Book Publication wizard that enables you to launch a book publication. No parameter.2.2. No parameter. 444 2013-09-04 .18. No parameter.17. This API opens the dialog box that enables to save a book publication template to the server.18.APIs Applies to: Planning and Consolidation connections. No parameter. 40.2.17.2 OpenDistributionTemplate This API opens the dialog box that enables to select an existing distribution template. 40.18 Distribution and Collection 40.1 CreateDistributionTemplate This API opens the Distribution Template dialog box.2.5 SaveBookPublicationTemplate This API performs a save of the current book publication template. 40. 40.2. 2.APIs No parameter. 445 2013-09-04 . This API opens the dialog box that enables to save a distribution template to the server.18. 40.4 SaveAsDistributionTemplate Applies to: Planning and Consolidation connections. No parameter. 40.5 SaveDistributionTemplate This API performs a save of the current distribution template. No parameter. This API validates the active distribution template. 40. No parameter.18.2.18. 40.6 OpenDistributionWizard This API opens the Distribution Wizard.2.18. No parameter.3 ValidateDistributionTemplate Applies to: Planning and Consolidation connections.2. This API opens a specific document that is stored in the Documents view of Planning and Consolidation. Parameter Description documentName As String teamId As String Name of the file to open. No parameter. Note: The last three parameters define the path to the document. 446 2013-09-04 . Optional.2.oqy extension%]_[]" (the oqy file must be located in one of the folders specified as a local connection folder.APIs 40. as it appears in the Connection Manager dialog box.19 OpenSpecificDocument Applies to: Planning and Consolidation connections. See Types of Connections) • "[%connection name%]".7 OpenCollectionWizard This API opens the Collection wizard that enables you to launch a data collection.18. Team that has access to this document. Syntax: • "_EPM_[% SolutionName% ]_[%server%:%port%]_[%environment%]_[%model%]" • "_EPM_LOCAL_[%oqy file name without . String subModule As String ConnectionString As String Folder. subFolderRequested As Folder. 40. Connection.2. 20. 40.4 DataManagerCreateNewTransformationSheet() This API creates a new transformation sheet in the Data Manager.2.20. 40.20.2 DataManagerCreateConversionFile() This API creates a conversion file in the Data Manger.2. 40.5 DataManagerOpenConversionFileDialog() This API opens the "Conversion File" dialog box.2.2.20 Data Manager 40.1 DataManagerClearSavedPromptValues() This API clears saved prompt values.20.APIs 40.2.3 DataManagerCreateConversionSheet() This API creates a conversion sheet in the Data Manager. 40. 447 2013-09-04 .2.20. 2.20.2. 40. 448 2013-09-04 . 40.6 DataManagerOpenDataPreviewDialog() This API opens the "Data Preview" dialog box. 40.11 Data ManagerOpenRunPackageLinkDialog() This API opens the "Run Package Link" dialog box. 40.8 DataManagerOpenFileUploadDialog() This API opens the "File Upload" dialog box.20.2.2.9 DataManagerOpenOrganizePackageDialog() This API opens the "Organize Package" dialog box.2.2.7 DataManagerOpenFileDownloadDialog() This API opens the "File Download" dialog box.20.20. 40.20.20.APIs 40.10 DataManagerOpenRunPackageDialog() This API opens the "Run Package" dialog box. APIs 40. 40.2.13 DataManagerOpenTransformationFileDialog() This API opens the "Transformation File" dialog box. teamId As String.20.14 DataManagerOpenViewLinkStatusDialog() This API opens the "View Link Status" dialog box. 40.20.20.2. 40.15 DataManagerOpenViewStatusDialog() This API opens the "View Status" dialog box.2. 449 2013-09-04 .16 DataManagerRunPackage(packageId As String.2.12 DataManagerOpenScheduleStatusDialog() This API opens the "Schedule Status" dialog box.2. fileName As String) This API allows you to run a package. 40.20.20. groupId As String. teamId As String groupId=Package Group teamId=Team Note: The comma must be used as the delimiter.APIs Parameter Description packageId As String. 40. groupId packageId=Package Name As String. Parameter Description packageLinkId As String.17 DataManagerRunPackageLink This API allows you to run a package link.2.19 DataManagerValidateServerTransformationFileDialog() This API launches validation of the server transformation file.20. 40.20.18 DataManagerValidateConversionFileDialog() This API opens a dialog box that allows you to validate a conversion file.2. 450 2013-09-04 .2. packageLinkName packageLinkID=Package Link Name As String packageLinkName=Package Name 40.20. • BEFORE_REFRESH Use this function to execute a custom operation before the system refreshes the data.Connect"). a dialog box will appear and display the text "Refresh successful".2.3 Assigning a Control Form to a Macro You can assign a control form to a macro.COMAddIns("FPMXLClient. 451 2013-09-04 . • AFTER_CONTEXTCHANGE Use this function to execute a custom operation after changing the context. Example: Assigning a button to the Refresh macro Option Explicit Sub Button5_Click() Dim api As Object Set api = Application. • AFTER_REFRESH Use this function to execute a custom operation after the system refreshes the data. Enter your code in modules. Example: After each refresh action.Object api.Refresh End Sub 40.4 Custom VBA Functions (Events) You can customize your Visual Basic for Applications (VBA) code by associating the events listed below.APIs 40. 40. • BEFORE_CONTEXTCHANGE Use this function to execute a custom operation before changing the context.20 DataManagerValidateTransformationFileDialog() This API opens the "Validate Transformation File" dialog box.20. For performance reasons.dll. use the GetMaxTupleByCellRequest event. if 200 tuples (member combinations) are retrieved. To change the number of tuples. Applies to: Planning and Consolidation connections • AFTER_WORKBOOK_OPEN Use this function to execute a custom operation after opening an Excel workbook. The return values to use for all the above events are: true or false.the maximum number of tuples (member combinations) by query when a refresh is performed. Applies to: Planning and Consolidation connections • AFTER_EXPAND Use this function to execute a custom operation after the system expands the EVDRE reports. EPMSaveData and EPMSaveComment.for EPM functions . • BEFORE_EXPAND Use this function to execute a custom operation before the system expands the EVDRE reports.APIs Enter the following lines in a module: Option Explicit Function AFTER_REFRESH() MsgBox "Refresh successful" AFTER_REFRESH = True End Function • BEFORE_SAVE Use this function to execute a custom operation before the system saves data into the database. 4 queries of 50 tuples will happen on a refresh.config file defines . • GetMaxTupleByCellRequest The parameter SmartQueryEngineMaxTupleByCellRequest in the FPMXLClient. for example. 452 2013-09-04 . • AFTER_SAVE Use this function to execute a custom operation after the system saves data into the database. Example: Before each refresh action. the number entered will be automatically taken into account instead of the default value in the FPMXLClient. if your workbook contains a lot of EPM functions such as EPMRetrieveData. The number entered will override the SmartQueryEngineMaxTupleByCellRequest number. This parameter cannot be modified during a session for a specific workbook.config. Enter the following lines in a module: Option Explicit Function GetMaxTupleByCellRequest() GetMaxTupleByCellRequest = 50 End Function In this example.dll. you might want to change the number of tuples during a session for a specific workbook. <EPMTab xmlns:xsi="http://www. that contains a toggle button called EPM Worksheet.org/2001/XMLSchema" xmlns="http://xml.w3.xml file that you create and store in \%userprofile%\AppData\Local\EPMOfficeClient\.1 RibbonXML. using macros and an . that contains a simple button called My Portal and a menu called Member Recognition.org/2001/XMLSchema-instance" xmlns:xsd="http://www. you must write each macro name in the RibbonXML. as an .com/2010/02/bpc"> <Group> <label>Custom Options</label> <Component> <type>ToggleButton</type> 453 2013-09-04 . Your extensions are added to the right part of the EPM tab of the Ribbon. Note: So that the extensions are loaded each time you open a Microsoft Excel workbook. that contains itself two toggle buttons called Member Recognition and Local Member Recognition. • The group called Custom Group. 3.Ribbon Extensibility Ribbon Extensibility 41.1.xla!myMacro 41. separated by a grey line.xml Content This section describes the content of the VBA RibbonXML. Create macros in a Microsoft Excel file.xml and store it in \%userprofile%\AppData\Lo cal\EPMOfficeClient\ 2.sap. save the file containing the macros.xml file. add-in for Microsoft Office. If you do this.xml file as follows: myFile. The Ribbon is automatically updated with your extensions.1 Ribbon Extensions: Simple Method You can create extensions to the Ribbon in simple way. Main Steps 1.xla file and add the file as an add-in to Excel.w3. In the example below. Create a file using VBA called RibbonXML. This section provides detailed information on how to extend the EPM tab of the Microsoft Office Excel Ribbon when using SAP BusinessObjects EPM Solutions. you add the following extensions to the EPM tab: • The group called Custom Options. There can be several components for a group. <type>: type of component. <label>: name of the group that will be displayed in the Ribbon. Note: If you add a menu component: • You will then add the <SubMenus> element.xml file must include: • the open tag: <EPMTab xmlns:xsi="http://www.org/2001/XMLSchema" xmlns="http://xml. that can be a button. ToggleButton or a Menu. <Component>: creates an element of the group. 454 2013-09-04 .Ribbon Extensibility <label>EPM Worksheet</label> <supertip>Define the current sheet as an EPM sheet or not</supertip> <keytip>ew</keytip> <onAction>EPMWorksheetAction</onAction> <onPressed>EPMWorksheetPressed</onPressed> <isEnabled/> </Component> </Group> <Group> <label>Custom Group</label> <Component> <type>Button</type> <label>My Portal</label> <supertip>Opens my portal</supertip> <keytip>mp</keytip> <onAction>testAction</onAction> <isEnabled>testEnable</isEnabled> </Component> <Component> <type>Menu</type> <label>Member Recognition</label> <supertip>Enables to activate or deactivate the member and local member recognition</supertip> <keytip>mr</keytip> <SubMenus> <Component> <type>ToggleButton</type> <label>Member Recognition</label> <supertip>Activates or deactivates the member recognition</supertip> <keytip>mc</keytip> <onAction>testAction</onAction> </Component> <Component> <type>Separator</type> </Component> <Component> <type>ToggleButton</type> <label>Local Member Recognition</label> <supertip>Activates or deactivates the local member recognition</supertip> <keytip>ml</keytip> <onAction>testAction</onAction> </Component> </SubMenus> </Component> </Group> </EPMTab> The RibbonXML. a toggle button or a menu.w3. You can add only one or several <SubMenus> elements to a menu.sap.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.com/2010/02/bpc"> • the close tag: </EPMTab> Here is the description of the various elements: Note: The text in the tag elements must be written exactly like in the example and the list below. A <SubMenus> element will contain one or several component elements. Enter them as follows: Button. • • • • <Group>: creates a group in the Ribbon. This is optional. xla file that you have installed as an add-in to Microsoft Excel).dll files as you want. <keytip>: keyboard shorcut for the component.dlls You can create as many .xla!myMacro.xla!myMacro. Word or PowerPoint Ribbon when using SAP BusinessObjects EPM Solutions. you may have to adjust your extensions. .xla!myMacro. which defines whether the component is greyed out or not. Note: If the macro is not saved in the current workbook (but in an . like any other custom development. 41. This parameter only applies to the toggle button type of component. • <isEnabled>: name of the macro to execute. add-in for Microsoft Office. • <onAction>: name of the macro to execute when clicking the component.dll file.xla file that you have installed as an add-in to Microsoft Excel). You can create extensions to the Ribbon using the .Ribbon Extensibility • • • • You can add a grey separator line by adding the separator type of component: <Component><type>Separator</type></Component> <label>: label to be displayed for the component. you must write each macro name as follows: myFile. Note: You cannot define keyboard shortcuts for the components inside a menu. Note: If the macro is not saved in the current workbook (but in an . <supertip>: tooltip to be displayed when hovering on the component. • <onPressed>: name of the macro to execute.2 Ribbon Extensions: Advanced Method Caution: As methods may change depending on the support package or the patch. You can include one or more classes (=extensions) in one . You can also add a new tab to the Ribbon. you must write each macro name as follows: myFile. You can extend the EPM tab of the Ribbon. 455 2013-09-04 .xla file that you have installed as an add-in to Microsoft Excel). which defines whether the toggle button is pressed or not. This section provides detailed information on how to extend the Microsoft Office Excel. you must write each macro name as follows: myFile. Note: If the macro is not saved in the current workbook (but in an . net framework. RibbonUtilies. • stdole. The Ribbon is automatically updated with your extension.ComponetModel. 2. The extensions inside the . see the "Methods" section of the current documentation.NET Framework 3. Add the following .2.5.dll". 2.RibbonUtilies. as follows: [ Export ( typeof ( IEpmRibbonExtensibility ))] public class MemberRecognitionCustomButton : IEpmRibbonExtensibility { • Implements all the methods that are defined in the interface IEpmRibbonExtensibility. 4. Word or PowerPoint. If you use Visual Studio 2010. 1. 3.dll V12 This dll is available in .dll Browse to the folder that contains the EPM add-in dlls.dlls. • Add [Export(typeof(IEpmRibbonExtensibility))] just above the definition of the class. Create a .Ribbon Extensibility Main Steps 1. 5. Implement the interface IEpmRibbonExtensibility. 456 2013-09-04 .dll are automatically detected by the EPM add-in each time you open Microsoft Office Excel. 6. choose the . The dll must end with "RibbonExtension. NET Framework • Office. • Add this using: using FPMXLClient.Composition.dll is generated. Create an empty class library project. NET Framework • System. Create an empty class. For more information about the methods. 41.dlls as References in the project: • FPMXLClient.1 How to Create a Ribbon Extension Use Microsoft Visual Studio 2008 or 2010. 3. Build your project.dll Browse to the folder that contains the EPM add-in dlls. The dll is named after the project and therefore ends with "RibbonExtension.dll".Composition.ComponetModel. using System.dll This dll is available in .dll file and store it in the folder that contains the EPM add-in . Set a name that ends with "RibbonExtension". The . If two extensions have the same priority order. Word. Open Microsoft Office Excel. if an extension with priority order 4 deletes a group in a tab of the ribbon and another extension with priority order 3 modifies the same group. The order is very important.DeleteReportButton.2.Add(newEpmRibbonAction(Commands. the extension will not be applied to the EPM add-in when you open Microsoft Excel or PowerPoint. Copy the dll and paste it in the folder that contains all EPM add-in dlls.2.Remove)). There are four possibilities: Microsoft Office Excel. "". actionList. Modifies components (such as buttons and menus) in the EPM custom tab in the ribbon.2. actionList. all applications If you choose Microsoft Word as a type.1 List<EpmRibbonAction> GetRibbonComponents().Remove)). ActionType. true. we do not guarantee in which order the extensions will be performed.AnalysisGroup. false). 8.2.CreateNewButton(RecordButton. • Type: Indicates the type of the current extension. For example.2. ActionType. true.Ribbon Extensibility 7. Button recordButton = Group. 41. 41.1 Properties • • OfficeApplication: to get the officeApplication PriorityOrder: to sort the extensions.2. Word or PowerPoint. Caution: The priority order must not be lower than 5. Example List <EpmRibbonAction> actionList = newList<EpmRibbonAction>().2 Methods 41. PowerPoint. Your extension is taken into account.2.2 Interface Implementation Details 41. the result in the EPM add-in will not be the one expected.Add(newEpmRibbonAction(Commands. 457 2013-09-04 .2. publicconststring RecordButton = "RecordButtonId".Add(newEpmRibbonAction(Commands. customGroup. true. true. keeping in mind the following: public conststring PlusButton = "PlusButtonId".AddNewButton(OpenButton.DeleteReportButton. you return the list of actions.EditReportButton. return actionList. customGroup. true. componentsToAdd)). publicconststring ExtensibilityGroup = "ExtensibilityGroupId". true.CollaborationGroup. string. Example explained The method returns the following list of actions: List <EpmRibbonAction> actionList = newList<EpmRibbonAction>(). These actions add to the EPM tab a group that contains three buttons. public conststring PlusButton = "PlusButtonId". ActionType.AnalysisGroup. newList<object>() {recordButton })).DeleteReportButton.Add(newEpmRibbonAction(Commands. actionList. actionList. customGroup. true. "".Empty). ActionType. Then. actionList. ActionType.Add(customGroup).Add(customGroup). The group is placed before the Collaboration group. componentsToAdd.Add(newEpmRibbonAction(Commands.Ribbon Extensibility actionList.AddNewButton(Commands.DeleteReportButton. string.AddNewButton(PlusButton. This button is placed after the Edit Report button and is the same type of button. The above actions are performed.Remove)). ActionType. customGroup. true.AddNewButton(PlusButton.CreateNewButton(RecordButton.Empty). 458 2013-09-04 . actionList.AddBefore. publicconststring RecordButton = "RecordButtonId".CreateNewGroup(ExtensibilityGroup). string.AddAfter.AddAfter. true. string.CollaborationGroup. actionList.Add(newEpmRibbonAction(Commands. This action deletes the Delete Reports button from the EPM tab.AddBefore. List <object> componentsToAdd = newList<object>(). true. true. publicconststring StarButton = "StarButtonId". List <object> componentsToAdd = newList<object>(). These actions add the button of your choice to the EPM tab.Empty). true. newList<object>() {recordButton })).Remove)). Group customGroup = Tab.Add(newEpmRibbonAction(Commands.Empty). Note: This is a good example of how you can move a button from one group to another group: you have already specified the removal of the Delete Reports button and then you specify adding it to another group. return actionList. publicconststring ExtensibilityGroup = "ExtensibilityGroupId". true. Button recordButton = Group.Empty).EditReportButton. This action deletes the Data Analysis group from the EPM tab. customGroup. componentsToAdd. customGroup. Group customGroup = Tab.Empty). publicconststring StarButton = "StarButtonId".CreateNewGroup(ExtensibilityGroup). namely the Delete Reports button. false).Add(newEpmRibbonAction(Commands. string. true. ActionType. true. true. componentsToAdd)).AddNewButton(OpenButton.AddNewButton(Commands. ActionType. string. Defines the behavior of the custom buttons defined in method List < EpmRibbonAction > GetRibbonComponents(). tabs.Add(newAddInCommand(PlusButton.Ribbon Extensibility 41. commands. } Example explained The method returns the following list of actions: These actions create a list of commands for the EPM add-in..HasActiveConnection | AddInState.HasActiveConnection. Adds a new tab to the ribbon.Tab>GetAdditionalTabComponent().2 List<FPMXLClient. Caution: To be able to add an action to a custom button.HasActiveConnection)).ActiveDocumentIsIn putable)). commands. commands.CreateNewTab( "TabCustomID" ). AddInState.2. List < Tab > tabs = new List < Tab >(). public List<AddInCommand> GetCustomCommands() { List<AddInCommand> commands = newList<AddInCommand>().2.Add(newAddInCommand(StarButton. commands.RibbonUtilies. AddInState. The PlusButton is enabled only if the current worksheet of the EPM add-in is connected and is an input form (when the "Use as Input Form" option is selected). } Example public List < Tab > GetAdditionalTabComponent() { Tab customTab = Ribbon . AddInState.2. 459 2013-09-04 .2. do the following: public List <Tab> GetAdditionalTabComponent() { return null.Add(newAddInCommand(RecordButton. return tabs. AddInState. If you do not want to add a tab.HasActiveConnection | AddInState.3 List<AddInCommand> GetCustomCommands(). Example public List<AddInCommand> GetCustomCommands() { List<AddInCommand> commands = newList<AddInCommand>().HasActiveConnec tion)).Add(newAddInCommand(PlusButton. each custom button must be linked to an AddInCommand in the method GetCustomCommands.2.2.Add(customTab). } 41. AddInState. return commands. meaning when the buttons are displayed and when they are enabled.ActiveDocumentIs Inputable)). 2.2. The RecordButton button is displayed and enabled only when the EPM add-in is connected. AddInState.HasActiveConnection)).2. return commands. case StarButton: //Implement custom action 2 break.2.5 string GetExtensionDescription(). case RecordButton: //Implement custom action 3 Break. Returns a description for your extension. Caution: This method must not return a null description.2. Defines the action that is performed when the user clicks the custom buttons defined in method List < EpmRibbonAction > GetRibbonComponents(). } 41.6 string GetNameForEpmCoreRibbon().HasActiveConnection)). To leave the name of the EPM add-in tab as is: public string GetNameForEpmCoreRibbon() { return string. } 41.. If null or empty is returned.Add(newAddInCommand(StarButton.2. } 460 2013-09-04 .Ribbon Extensibility The StarButton is enabled only when the EPM add-in is connected. AddInState.4 void RibbonOnAction(IRibbonControl ribbonControl).Empty. AddInState. Example public string GetExtensionDescription() { return"CustomerXXXExtension". } 41.Id) { case PlusButton: //Implement custom action 1 break. Example public void RibbonOnAction(IRibbonControl ribbonControl) { switch (ribbonControl.Add(newAddInCommand(RecordButton. commands.HasActiveConnection.2. Renames the EPM add-in tab. commands. You can define the actions you want.2.2. the extension will be disabled by the EPM add-in. .2. //Replace by the list of element that you want to display EPMExcelSheet epmExcelSheet = newEPMExcelSheet(ExcelApplication.Key)).keyValue.8 string RibbonGetLabel(IRibbonControl ribbonControl).. "RibbonOnActionForDynamicExtension").Add(newKeyValuePair<string. menuElement.SetAttribute("tag".Format("Report{0}". element.2.SetAttribute("label".OuterXml. whose content changes depending on the context. You create dynamic buttons in very specific cases. Example public string RibbonGetLabel(IRibbonControl ribbonControl) { switch (ribbonControl.com/office/2006/01/customui"). string>>().Empty. menuElement. List<string> reportList = reportManager.AppendChild(customTest).SetAttribute("onAction".GetReportList().2.Ribbon Extensibility To change the name of the EPM add-in tab: public string GetNameForEpmCoreRibbon() { return"EPM for CustomerXXX". } return xmlDoc. the tab is renamed with it.SetAttribute("id". enter return string.CreateElement("button").Id) 461 2013-09-04 . element.GetReportName(report))). } foreach (KeyValuePair<string. string>> listCustom = newList<KeyValuePair<string.CreateElement("menu").XmlDocument().. customTest. reportManager. menuElement. keyValue. string> keyValue in listCustom) { // A Button for each element in the list XmlElement element = xmlDoc. 41.Value). string. } If you return a value.AppendChild(element).7 string RibbonGetContent(IRibbonControl ribbonControl). //Here is create a fake list. XmlElement customTest = xmlDoc. } 41. just to have a list. "http://schemas. Creates dynamic buttons.SetAttribute("id". Returns the label to display for each custom button or group.ActiveSheet as_Worksheet).Key). "CustomSeparatorRA1").2. EPMReportManager reportManager = EPMExcelReportManagerRepository. keyValue.SetAttribute("title". foreach (string report in reportList) { listCustom. customTest.microsoft. XmlElement menuElement = xmlDoc.GetReportManager(epmExcelSheet).SetAttribute("xmlns".AppendChild(menuElement).2.2. If you do not want to create any dynamic buttons. element. string>(report. Example public string RibbonGetContent(IRibbonControl ribbonControl) { XmlDocument xmlDoc = new System. //each element must call RibbonOnActionForDynamicExtension as callBack //then the method RibbonOnAction will be called each time the user clicks on the button element. "Dynamic Report List").CreateElement("menuSeparator"). List<KeyValuePair<string. xmlDoc.Xml. } 41. } returnnull.2. case ExtensibilityGroup: return"Extensibility".2. 462 2013-09-04 . Sets KeyTip for custom buttons or groups. Returns the tooltip to display for each button or group. case PlusButton: return"Plus".Ribbon Extensibility { case StarButton: return"Get Active Report".11 void RibbonOnActionToggle(IRibbonControl ribbonControl.2.Id) { case PlusButton: return"Plus button for test". } returnnull. case RecordButton: return"Play a recorded scenario".2. To use the key tips. bool isPressed). enter return string.Id) { case StarButton: return"AR".2. Example /// <summary> ///Not mandatory ///</summary> ///<param name="ribbonControl"></param> ///<returns></returns> publicstring RibbonGetKeyTip(IRibbonControl ribbonControl) { switch (ribbonControl.Empty. If you do not want to set keytips. the user clicks the "F10" or "Alt" on the keyboard. Example public string RibbonGetDescription(IRibbonControl ribbonControl) { switch (ribbonControl. case PlusButton: return"ST". } 41. } 41.10 string RibbonGetKeyTip(IRibbonControl ribbonControl).2.2. case OpenButton: case OpenButton2: return"Open custom UI". Defines the action that is performed when the user clicks the custom toggle buttons defined in method List< EpmRibbonAction> GetRibbonComponents().2. } returnnull. case RecordButton: return"Play Record".2.9 string RibbonGetDescription(IRibbonControl ribbonControl). Ribbon Extensibility Example public void RibbonOnActionToggle(IRibbonControl ribbonControl. public bool RibbonGetEnabled( IRibbonControl ribbonControl) { return true .2.IPictureDisp ImageToPictureDisp(Image image) { return (stdole.Id) { case PlusButton: returnAxHostConverter.2. Displays an image on custom buttons.ShowMessage("Dynamic Toggle Button is now pressed").ShowMessage("Dynamic Toggle Button is now not pressed"). else Actions.2.12 bool RibbonGetEnabled(IRibbonControl ribbonControl). bool horizontalFlip).ImageToPictureDisp(Resources. } returnnull. break.Id) { case"CustomButtonID": if (isPressed) Actions.Empty) { } staticpublic stdole.2.GetObject("Plus") asImage). } staticpublicImage PictureDispToImage(stdole.IPictureDisp)GetIPictureDispFromPicture(image).ResourceManager. Example public IPictureDisp RibbonGetImage(IRibbonControl ribbonControl.ImageToPictureDisp(Resources.IPictureDisp pictureDisp) { return GetPictureFromIPicture(pictureDisp). bool horizontalFlip) { switch (ribbonControl. } } 41.GetObject("Star") asImage). } } 463 2013-09-04 . Always return true. } 41.ResourceManager.ImageToPictureDisp(Resources.13 IPictureDisp RibbonGetImage(IRibbonControl ribbonControl.ResourceManager.GetObject("Record") asImage).2. default: break. bool isPressed) { switch (ribbonControl.2. case StarButton: returnAxHostConverter. } Note that the AxHostConverter class is as follows: internalclassAxHostConverter : AxHost { private AxHostConverter() : base(String. case RecordButton: returnAxHostConverter. 2. true). Always use this code: publicIPictureDisp RibbonGetImageWithHorizontalFlip(IRibbonControl ribbonControl) { return RibbonGetImage(ribbonControl. Always use this code: publicIPictureDisp RibbOnGetImageWithNoHorizontalFlip(IRibbonControl ribbonControl) { return RibbonGetImage(ribbonControl.14 IPictureDisp RibbonGetImageWithHorizontalFlip(IRibbonControl ribbonControl).2.2.2.2. Always use this code: public bool RibbonGetVisible(IRibbonControl ribbonControl) { returntrue.Ribbon Extensibility 41.2. else return false. public bool RibbonGetPressed(IRibbonControl ribbonControl) { switch (ribbonControl. } 41.2. false). default: returnfalse.2.Id) { case "Toggle Button Id": if (condition) return true.2.2.16 bool RibbonGetVisible(IRibbonControl ribbonControl). } 41.17 RibbonGetPressed(IRibbonControl ribbonControl). } } 464 2013-09-04 . } 41. Defines if the toggle custom buttons must be pressed or not.2.15 IPictureDisp RibbOnGetImageWithNoHorizontalFlip(IRibbonControl ribbonControl).2. internal IDs will appear as names for the members. Note: If the language of the retrieval tool is not available in the SAP NetWeaver BW InfoCube. if the data language is specified in the . When connected to a local connection. You can change the application language. use the Application Language and Data Language options in EPM > User Options. • Data language. 465 2013-09-04 . the add-in inherits the SAP BusinessObjects Enterprise BI launch pad application language defined for the current user. If the data language you select does not exist in a cube or model.Languages Languages • Application language. it inherits all the Windows international settings for number and date defaults and formats. When connecting to an SAP NetWeaver BW InfoCube. Because the EPM add-in is integrated into Microsoft Office Excel. Word and PowerPoint.oqy file. You can change the data language. To change the languages. it overrides the data language specified in the User Options. The command names in the EPM tab are displayed in the language you have selected when you restart the application. you choose the data language. members are displayed in the cube/model default language. Note: If you have opened the EPM add-in from SAP BusinessObjects Enterprise BI launch pad. Languages 466 2013-09-04 . The screen that opens states the EPM add-in version and copyright information. by selecting EPM > About > Check for Updates. • The updates that are available. 467 2013-09-04 . see Update. by selecting EPM > About > About EPM Add-in. For more information about updates.About the EPM Add-In About the EPM Add-In You can consult the following information: • The current version of the EPM add-in. About the EPM Add-In 468 2013-09-04 . follow one of these steps: • Perform a log on. Extended Analytics Analyzer should not be installed. 469 2013-09-04 . Then. Caution: When you migrate the reports. open the workbook containing the reports. Note: The dynamic formatting sheet is migrated when you open the workbook. To do so. • Select Report Actions > Manage Connections > Report Connections and connect the reports you want.2 Planning and Consolidation EvDRE Migration You can migrate EvDREs created with SAP BusinessObjects Planning and Consolidation 7. perform a refresh. All the reports are automatically connected if the connections are correctly defined.5. The structure levels are applied.) The following items are not migrated: attribute filtering. If a cube has changed. For certain items that are not migrated. This chapter aims to help you with the EvDRE migration by listing: • All the EvDRE items that are migrated. the EPM add-in equivalent features that you will be able to use in your reports after migration. you can change the connection for a report Then. are referred to in this chapter. Related Topics • Logging On and Off • Connection Management 44. Not all items are listed. Flash objects.Migration Migration 44. as the possible cases are so numerous.5. All the members are identified as EPM members ("=EPMOlapMemberO" is displayed in the formula bar when you select a member in the report.1 Extended Analytics Analyzer Report Migration You can migrate reports created with SAP BusinessObjects Extended Analytics Analyzer 7. • The EvDRE items that are not migrated. KeysRange. 44. It is not necessary to write the model name.2. You can alternatively reference a cell that contains the model name. For more information. For more information. An EvDRE can generate several reports. • • 44. • ColKeyRange. the KeysRange and the ExpansionsRange must be on the same sheet. For example: =EVDRE("Plan ning".A22:D28). see KeysRange.A14:B19. The model name can be in another worksheet. add-in for Microsoft Office.2. Otherwise. therefore inserting additional parentheses. • RowKeyRange. the items that cannot be migrated are listed in the log file. see RowKeyRange and ColKeyRange Members. So the EvDRE formula must be defined as follows to be migrated: • =EVDRE("ModelName".A14:B19) • Or =EVDRE("ModelName". Note: • When migrating sheets. Caution: You cannot migrate a protected worksheet or workbook. two or three.ExpansionsRange).KeysRange). What is called an "application" in version 7. • Its formula contains only one or two separator characters.A14:B19. see RowKeyRange and ColKeyRange Members. the EvDRE is not migrated.A22:D28) where cell F2 contains the model name.Migration Note: As a general rule. What is called "application set" in version 7. For more information.2 KeysRange The following ranges are migrated: • PageKeyRange. depending on the number of parameters. when launching the migration. For example: =EVDRE("Planning". refer to the SAP BusinessObjects EPM Solutions.5 of Planning and Consolidation is called "model" in version 10.A14:B19. For example: =EV DRE(Sheet2!D8. 470 2013-09-04 . the EV functions are kept and some of them continue to work with EPM add-in. where cell D8 of Sheet2 contains the model name.5 is called "environment" in version 10.A22:D28) Note: • • The EvDRE formula. For example: =EVDRE(F2. What's New guide.1 EvDRE Formula An EvDRE is migrated if: • Its formula does not contain another formula. For more information on the EV functions that are not recognized by the EPM add-in. see RowKeyRange and ColKeyRange Members. In some cases. The following ranges are not migrated: • CellKeyRange. You can use the EPM add-in equivalent features. The RowKeyRange members are migrated to what is called the "row axis" of a report in the EPM add-in. 44. For more information. a dimension can be used only in one of the three axes (page. row or column). For for more information. The PageKeyRange members are migrated to what is called the "page axis" of a report in the EPM add-in. The empty rows and columns contained in the EvDRE reports are migrated and remain in the migrated reports. • SortRange. depending on what you want to do: the Keep Formula on Data option. 471 2013-09-04 . Note: In this case. see ExpansionsRange. For more information. Therefore. the migrated reports will be static.2. • • • • If an ExpansionsRange is defined for the EvDRE. if a dimension is used in the RowKeyRange or the ColKeyRange. see Keep Formula on Data and Show Source Data in Comments and Local Members. see Format Migration.3 Report Members and Axes The reports are migrated: • If there is no ExpansionsRange defined for the EvDRE. but it is not used and its member is not identified by a formula beginning with =EPMOlapMemberO(. and also in the PageKeyRange. or local members. see OptionRange. In an EPM add-in report (on a Planning and Consolidation connection). see Read-only Data. You can use the EPM add-in equivalent feature: Read-only Data. members in the RowKeyRange or the ColKeyRange are not recognized as valid members and are not migrated.Migration • • FormatRange. see Data Sorting . they will not contain any dynamic member selection. The ColKeyRange members are migrated to what is called the "column axis" of a report in the EPM add-in. the reports are migrated based on the definition of the EvDRE resulting reports in the sheet. and the dimension is displayed in the page axis range just for your information. For more information. For more information. For more information. the dimension remains in the row or column axis. once migrated. OptionRange. the reports are migrated based on the ExpansionsRange content. For more information. • GetOnlyRange. You can use the EPM add-in equivalent feature: Data Sorting. 2010.2009. 44. they are automatically deleted as soon as you perform a refresh that changes the members displayed in the report. Member Migrated or not Identified by a formula beginning with =EVCVW( Not taken into account. the keys are migrated into EPMOlapMemberO. The headings are left in the sheet just for information (they are not identified as EPMOlapMemberO). After the migration.3. Migrated. Several members separated by a comma For example: 2008. The formula remains after migration but is not migrated into a formula beginning with =EPMOlapMemberO(. You are then able to choose another display name for members in the Member Selector dialog box. There is no equivalent to headings in the EPM add-in. The member is identified by a formula beginning with =EPMOlapMemberO( Migrated. Note: When several members are selected for the same dimension in the page axis.TOTAL.TO.The members altogether are identified by a formula TAL beginning with =EPMOlapMultiMember(. see Member Name to Display. the descriptions of members are displayed by default. The member is identified by a formula beginning with =EPMOlapMemberO( Identified by a formula different from =EVCVW( Hard-coded member For example: 2010.TOTAL Migrated. the data on the members is automatically aggregated in the report. • If a member appears in several dimensions.1 PageKeyRange Members The PageKeyRange members are migrated to what is called the "page axis" of a report in the EPM add-in. For this reason.2. 472 2013-09-04 .TOTAL.Migration About Keys and Headings For each KeyRange. the dimension to which the member is attached may not be identified. For more information. In the key cells. you should always specify the dimension caption for each member in the PageKeyRange on the left column to the members column. but it is not identified by a formula beginning with =EPMOlapMemberO(. If at least one of the row or column axes does not contain any members.2 RowKeyRange and ColKeyRange Members • • All the members contained in a RowKeyRange (beginning with the top-left member in the range) are migrated to what is called the "row axis" of a report in the EPM add-in. • 473 2013-09-04 .Migration • If the PageKeyRange references several ranges. The formulas that reference other cells are also migrated and continue to reference the same cell. All the members contained in a ColKeyRange (beginning with the top-left member in the range) are migrated to what is called the "column axis" of a report in the EPM add-in. the report is not migrated. meaning that they do not have the standard behavior of members in the EPM add-in. Migrated or not Member Identified by any formula Migrated. The member is identified by a formula beginning with =EPMOlap Member( ev_before and ev_after parameters Migrated. all the ranges will be migrated into only one page axis for all the EvDRE reports. 44. Unrecognized and Not Migrated Members In some cases.3. only the first one read by the migration process is migrated. following this rule: if several members of the same dimension appears in the different ranges. members are not recognized as valid members or simply not migrated. a member has been deleted from the environment): • The following sentence is displayed in the log: The member '{0}' at position [{1}. • The member remains in the page axis range just for your information. Members whose formula begins with =EPMInsertedMember( are "fake" members.2. The member is identified by a formula beginning with =EPMIn sertedMember( Note: • • All member formulas are migrated. When a member is not recognized in the page axis (for example.{2}] is not valid.TOTAL Migrated. The member is identified by a formula beginning with =EPMOlap Member( Hard-coded member For example: 2010. These members ensure the continuity of the row or column axis. The other members of the dimension are still displayed but they are not recognized as an EPMOlapMemberO. If two EvDREs reference a part of the same report range (meaning at least one cell in common and not the full range). if a PageKeyRange is not above the RowKeyRange and ColKeyRange. When migrated. Therefore. To migrate both reports.3 About Axes About Axes • The EPM add-in does not support reports when the page axis is not above both row and column axes.3. the temporary rows and columns for the unrecognized members are deleted. the Microsoft Office Excel "General" number format is automatically applied to all the cells of the row and column axes. see After Migration. if a ColKeyRange is under the RowKeyRange. the report is not migrated. the report is not migrated.whether it is the PageKeyRange. the RowKeyRange or ColKeyRange: only the report that is overriden by the other report is migrated. the entire row or column is not valid. If a report is located between the data range and the RowKeyRange or the data range and ColKeyRange of another report. Therefore. move the PageKeyRange above the RowKeyRange and ColKeyRange. if the RowKeyRange contains two ranges and the ColKeyRange contains three ranges. For more information. For example.{2}] is not valid for the dimension '{3}' • The member cell is colored in magenta on a row or column created temporarily. As soon as you perform a refresh on the report. When a member is not recognized in a row or page axis (for example. If an EvDRE contains several report ranges. two reports are created. • • The first report will use the first range of the RowKeyRange and the first range of the ColKeyRange. the report is migrated. move the inside report outside of the other report. You can easily spot the members that you will not find in your report.2. members are not recognized as valid members or simply not migrated. See below.Migration • • • When there is more than one dimension in a row or in a column axis and if one member is not recognized. The second report will use the second range of the RowKeyRange and: • • • • • 474 2013-09-04 . the lowest number of ranges determines the number of reports to be migrated. Unrecognized and Not Migrated Members In some cases. a member has been deleted from the database): • The following sentence is displayed in the log: The member '{0}' at position [{1}. To ensure that you can migrate the report. only one report is migrated (the first one that is read during the migration process). the number of reports is determined as follows: the RowKeyRange contains more than one range and the ColKeyRange also. When the RowKeyRange is on the right side of the ColKeyRange. The EPM add-in does not support reports when the column axis is under the row axis. 44. All the merged cells in the row and column axes are automatically unmerged during the migration process. the EPM add-in supports the share of an entire axis (meaning the exact same range of cells). Caution: Also. the second EvDRE is not migrated. report 000 is migrated and does not share an axis with report 001. If one EvDRE contains two reports that share the same PageKeyRange. Note: About SHEET: • If reports have already been generated based on the SHEET parameter.4 ExpansionsRange Here is the list of ExpansionsRange parameters that are migrated and the ones that are not migrated. the second range of the ColKeyRange (and the third range is not migrated). the Time dimension will not be part of report 1. and the RowKeyRange of report 2 is not aligned on the RowKeyRange of report 1. The parameters below are migrated: • ExpandIn. after migration. not just a part of it. 475 2013-09-04 .2. After migration. If two reports share an axis: if report 000 is valid and 001 is not valid and therefore not migrated. after migration. the reports can be migrated. Shared KeyRanges As a general rule. SHEET is not migrated. if the ranges are not on the same row. the second EvDRE is not migrated. Only one report is migrated (the first one that is read during the migration process). If two reports on a different model share a KeyRange. row [ ] . Same case if you have two ColKeyRange that are not aligned. • Since both reports share the PageKeyRange. If two EvDREs in the same sheet reference the exact same ColKeyRange and RowKeyRange. Time will not be included in the page axis. If two reports share the same ColKeyRange. • • "Butterfly" reports are migrated. but on different models ([model name] <-> [model name] ): axis sharing is not be possible. for example: • Report 2 contains the Time dimension in the ColKeyRange or RowKeyRange and in the PageKeyRange. an axis can be shared only if the reports that share the axis are on the same model. • • • • 44. If two EvDREs in the same sheet reference a range that is part of another EvDRE ColKeyRange or RowKeyRange.column [ ] is used by 2 different EVDRE reports.Migration • • the second and third ranges of the ColKeyRange. the migration process unshares the KeyRange and the following message is displayed in the log file: Range row [ ] .column [ ]. COL and ROW are migrated. if the ranges are on the same row. the two row axes will be automatically aligned. • The EPM add-in equivalent feature is: Workbook Sheet Automatic Generation. Migration • • • • Dimension.TOTAL) or dynamic (for example: LDEP(2.2008. MemberSet. the members are migrated only if the delimiter character is a comma. based on the EPM function called "EPMDimensionOverride". whether they are static (for example: 2007. See MemberSet. the ReportID parameter will specify one or more reports. When there are several dimensions in an axis.TOTAL. BeforeRange. • Insert.Y)).1 MemberSet Following is the list of MemberSet values that are migrated and the ones that are not migrated: Note: To ensure that members are recognized as members. in the MemberSet row.2. See Member Entry Directly in a Sheet and Member Entry Using the Member Selector. After migration. see EPMDimensionOverride. AfterRange. the Dimension parameter will specify the dimension and the Members parameter will specify the migrated formula. 44. enter member names in ' ' (single quotes) or " " (quotation marks) when member names contain spaces or special characters. See BeforeRange and AfterRange. Formula Any formula is migrated.4. You can use the EPM add-in equivalent feature: the Remove Empty options for rows or columns. 476 2013-09-04 . You can use the EPM add-in equivalent feature: entering members directly in a sheet or using the Member Selector dialog box. See No Data and Zero Values. Note: When several members are specified. In the EPMDimensionOverride function. the inner and outer dimensions are therefore kept in the original order. the cell that contains the EPMDimensionOverride function appears in yellow. the ExpansionsRange is read from left to right. For more information. See BeforeRange and AfterRange. Hard-coded Hard-coded values are migrated. Note: During the migration process. The values below are not migrated: • Suppress. the following text is displayed in the log: The expansion range [Q4:Q6] should contain at least one recognized member. there are the members ACTUAL and FORECAST. do not delete the cell in yellow. see After Migration. in the MemberSet row. see After Migration. 477 2013-09-04 . For more information. Caution: To ensure that the migrated report continues to function. • The range contains three other columns. Range The following two ways of entering a range are supported: =EVRNG( and A5:D8 • When a range is defined for a row axis: • The members in the first column are migrated. the ReportID parameter will specify the report. do not delete the cell in yellow. and the third cell does not contain any member. For more information. see Local Members. You can move it to another cell in the sheet. In the EPMCopyRange function. • In the first column of the range. For more information. • The other columns of the range are migrated. • If the members are not only in the first column but in other columns. the Rows parameter will specify TRUE and the SourceRange parameter will specify all the columns of the range except for the first column. • If a cell in the first column does not contain any members.Migration Caution: To ensure that the migrated report continues to function. it is however migrated into an empty local member. based on the EPM function EPMCopyRange. the cell that contains the EPMCopyRange function appears in yellow. After migration. Note: For more information on local members. This local member is attached to the member in the above cell. see EPMCopyRange. You can move it to another cell in the sheet. • If none of the members in the first column of the range are recognized as valid members. Example: In this EvDRE: • The second row references a range (N12:Q14). the members are ignored and therefore not migrated. • If a member is not recognized as a valid member. the cell is still migrated into what is called a "local member" in the EPM add-in. based on the EPM function EPMCopyRange. 478 2013-09-04 . The other columns of the range are migrated.Migration Once migrated. • The third cell of the first column of the range that does not contain any members is migrated into a local member. as you can see in the formula bar. • When a range is defined for a column axis: • The members in the first row are migrated. the following occurs: • • The members in the first column of the range replace the members already existing in the second row of the report. The EPMCopyRange function replaces the range reference in the MemberSet paramater (see the cell selected and the formula bar). the members from the context are applied in the axis after the migration. see After Migration. In the EPMInsertCellsBeforeAfterBlock function: the ReportID parameter will specify the report. the cell that contains the EPMCopyRange function appears in yellow. do not delete the cell in yellow. the cell is still migrated into what is called a "local member" in the EPM add-in. in the MemberSet row. see EPMInsertCellsBeforeAfterBlock. based on the EPM function called "EPMCopyRange". based on the EPM function called "EPMInsertCellsBeforeAfterBlock". You can move it to another cell in the sheet. 44. see EPMCopyRange. the Range parameter will specify the entire migrated range.2.2 BeforeRange and AfterRange The following two ways of entering a range are supported: =EVRNG( and A5:D8 The ranges for BeforeRange and AfterRange are migrated. the ReportID parameter will specify one or more reports. For more information. If a member is not recognized as a valid member. the cell that contains the EPMInsertCellsBeforeAfterBlock function appears in yellow. 479 2013-09-04 . the Before parameter will specify TRUE to insert the cells before the dimension members. For more information. If a cell in the first row does not contain a member. FALSE to insert the cells after the dimension members. Once you refresh the sheet. After migration. This local member is attached to the member in the left cell.Migration • • • • If the members are not only in the first row but in other rows. For more information. Caution: To ensure that the migrated report continues to function. the members specified in the MemberSet replace the members in the report axis. but the MemberSet members are valid.4. If none of the members in the first row of the range are recognized as valid members. it is however migrated into an empty local member. the members are ignored and therefore not migrated. the following text is displayed in the log: The expansion range [Q4:Q6] should contain at least one recognized member. Note: If no member is recognized in the axis of a report. In the EPMCopyRange function. • The other rows of the range are migrated. the Dimension parameter will specify the dimension. After migration. the Rows parameter will specify FALSE and the SourceRange parameter will specify all the rows of the range except for the first row. in the BeforeRange or AfterRange row. • SuppressNodata. do not delete the cell in yellow. see Member Sorting and Grouping by Properties.6 OptionRange Note: • • For each option. Yes. The other values are not migrated. • SumParent.2. Equivalent feature in the EPM add-in: Freeze Data Refresh.Migration Caution: To ensure that the migrated report continues to function. Equivalent feature in the EPM add-in: Calculate Parents in Hierarchies. • SQLOnly. You can view these options in the Sheet options and the Options tab of the Report Editor. You can move it to another cell in the sheet. for more information about the EPM add-in equivalent feature for the InsertAfter and InsertBefore parameters. N. the Remove Empty options for rows and columns are selected in the EPM add-in. 44. You can use the EPM add-in equivalent feature: Data Sorting. the Remove options for empty rows and columns are selected and a filter on rows that contain 0 is created so that rows with zero are not displayed in the report. the options are migrated only if the delimiter character is a comma. • When the value is Y or Yes. Equivalent feature in the EPM add-in: Auto Fit Column Width. You can view these options in the Sheet options and the Options tab of the Report Editor. For example: AutoFitCol=Y. • ShowComments. See No Data and Zero Values. after migration. • NoRefresh.NoRefresh=N The following options are migrated: • AutoFitCol. • When the value is N or No.2. See No Data and Zero Values. For more information. the values supported and therefore migrated are: Y. Equivalent feature in the EPM add-in: Keep Formula on Data and Show Source Data in Comments . No. For more information. Equivalent feature in the EPM add-in: Display only Base Level Data. after migration. see Data Sorting .5 SortRange The SortRange is not migrated. Also. Equivalent feature in the EPM add-in: Empty Cell Default Value . see After Migration. in the EPM add-in. • NoSend. Equivalent feature in the EPM add-in: Use as Input Form. • ShowNullAsZero. When several options are specified. 480 2013-09-04 . 44. You can view filter on 0 data in the Data Filtering tab of the Report Editor. SuppressDataCol. Member Name to Display HideRowKeys.7 Format Migration When migrating an EvDRE. the format settings are also migrated and stored in what is called a dynamic formatting sheet in the EPM add-in. 44. Equivalent feature in the EPM add-in: Ownership-based Hierarchies. you can choose the name you want to display for members. See Member Sorting and Grouping by Properties. In the EPM add-in: you can choose the name you want to display for members. Note: • • However. the entire EvDRE is not migrated and the following text is displayed in the log: Warn: The EVDRE function in cell [cell reference] will not be migrated because the option expandOnly is true. Equivalent feature in the EPM add-in: Metadata Cache. In the EPM add-in. Equivalent feature in the EPM add-in: Data Ranking. one dynamic formatting sheet is created and is applied to all the EvDRE reports. see Report Options. For more information on the report options inheritance. • ExpandOnly. The following options are not migrated: • Bottom. some options that apply to a specific report cannot inherit the sheet options. HideColKeys. Equivalent feature in the EPM add-in: Excluding Members. For each EvDRE migrated. Caution: If the ExpandOnly option is set to Y or YES. QueryType.2. QueryViewName. the inheritance option is automatically deselected and the following text is displayed in the log: Deactivate Sheet Options Inheritance. QueryEngine. SortCol. Equivalent feature in the EPM add-in: Member Sorting and Grouping feature in the Member Selector. In this case. if several EvDRE reference the exact same FormatRange.Migration Note: In the EPM add-in. Equivalent feature in the EPM add-in: Data Ranking. SuppressDataRow. only one dynamic formatting sheet will be created in the EPM add-in. All the format settings that are not specified in an EvDRE are left blank in the EPM dynamic formatting sheet (in the Use column cells). 481 2013-09-04 . • DumpDataCache. meaning that no format is applied. Top. Member Name to Display PctInput. • • • • • • • • • • • GroupExpansion. Equivalent feature in the EPM add-in: Excluding Members. Related Topics • Dynamic Formatting Template Definition 44.2. a formatting sheet is created based on the following: • The format of the top-left cell of the RowKeyRange is applied in the formatting sheet as the row default format for headers. • When the FormatRange is left blank.7. 482 2013-09-04 . • The format of the top-left cell of the data range is applied in the formatting sheet as the row and column default format for data. • 44. • The format of the top-left cell of the PageKeyRange is applied in the formatting sheet as the page axis default format for headers. a formatting sheet is created based on the following: • The format of the top-left cell of the RowKeyRange is applied in the formatting sheet as the row default format for headers. The following sheets are incremented: 001.7. • The format of the top-left cell of the PageKeyRange is applied in the formatting sheet as the page axis default format for headers. in the EPM add-in.Migration • If several formatting sheets are generated during the migration process. • When the FormatRange value is one cell. and so on. they are named as follows and do not exceed 31 characters: [full or partial name of the sheet containing the EvDRE]_000. When the FormatRange value is greater than one cell and references a full set of formatting features (within six columns).2.2 Columns of the Formatting Range When the FormatRange value is greater than one cell and references a full set of formatting features (within six columns). 002. • The format of the top-left cell of the ColKeyRange is applied in the formatting sheet as the column default format for headers. • The format of the top-left cell of the ColKeyRange is applied in the formatting sheet as the column default format for headers. see Columns of the Formatting Range. a formatting sheet is created based on these features. • The format of referenced cell is applied in the formatting sheet as the row and column default format for data. a dynamic formatting sheet is created based on these features.1 Format Range FormatRange is migrated into a dynamic formatting sheet in the EPM add-in. For more information. 7. list of values KEY="{string}" A row with the member and its format is added to the Dimension Member/Property Formatting area.1 CRITERIA column The values below are migrated: Migrated Value Location in the EPM add-in formatting sheet DEFAULT In the Default Format area of the Hierarchy Level Formatting area or the Page Axis Formatting.2. In the Calculated Member Default Format area of the Dimension Member/Property Formatting area. In the Inputable Member Default Format area of the Dimension Member/Property Formatting area. If two rows contain the exact same values except for the USE and PARAMETERS columns.Migration Note: • • • If none of the rows is recognized. CHANGED The values below are not migrated: • STATUS=n • LOCKED • HEADING="{string}" • FORMULA • VALUE = | <> | < | > | <= | >= {value} 483 2013-09-04 . In the Row and Column Banding area.property}="{value}" A row with the property and its format is added to the Dimension Member/Property Formatting supports "different-from" (<>) and comma-delimited area. depending on the value in the EVALUATE IN column of the EvDRE formatting range. If two rows contain the exact same values except for the FORMAT column. CALC INPUT {dim. if the ODDROWS parameter is in the APPLYTO column. no EPM dynamic formatting sheet is created. the formats in the USE and PARAMETERS are concatenated and migrated.2. In the Changed Member Default Format area of theDimension Member/Property Formatting area. the format of the second row is migrated and overwrites the format of the first row. 44. • • • • • • • • • • • FONTNAME FONTSIZE FONTSTYLE FRAME HORIZONTALALIGNMENT INDENTLEVEL LOCK NUMBERFORMAT PATTERN PROTECTION STYLE 484 2013-09-04 .7.2. The value below is not migrated: • CELL 44.7. In both Row and Column areas. In the Row areas.2. In the Page Axis Formatting area.3 FORMAT column Only the formatting settings specified in the USE and PARAMETER columns are migrated.2.2 EVALUATE IN column The values below are migrated: Migrated Value Location in the EPM add-in formatting sheet {blank} or ALL PAGE COL ROW ROWCOL In the Row or Column areas or both.2. In the Column areas. or the Page Axis Formatting area.Migration 44.2. 44.2.7.4 USE column The values below are migrated in the Use column cells of the EPM dynamic formatting sheet: • • • • • • ALL BORDER CONTENT FONT FONTBOLD FONTCOLOR Note: FONTCOLOR is migrated as FontColorIndex. • The comma is migrated as a vertical bar (pipe) character.2. • • • • • • • • • FONTNAME FONTSIZE FONTSTYLE HORIZONTALALIGNMENT INDENTLEVEL LOCK NUMBERFORMAT STYLE VERTICALALIGNMENT The value below is not migrated: • {VBA property} Regarding the syntax: • • This syntax is migrated: {Format property} = "value" This syntax is not migrated: {Format property} = {dimension}. The value below is not migrated: • {VBA property} 44.2. also in the Use column cells of the EPM dynamic formatting sheet: • • • CONTENT FONTBOLD FONTCOLOR Note: FONTCOLOR is migrated as FontColorIndex.7.{property} 44.2.5 PARAMETERS column The values below are migrated.Migration • VERTICALALIGNMENT Note: When a list of values is specified: • The values are migrated only if the delimiter character is a comma.2.6 APPLY TO column The values and the parameter below are migrated: 485 2013-09-04 .7. ..8 Migration Log The migration log lists the migration steps and the items that are migrated or not. Start process with evdre number [num. Checks that the ExpandOnly option is not set to Y or YES. Start reading member definition. that you will see in the log file: Note: Within each step. the log can display detailed information. when a member is not recognized. Indicates the beginning of the analysis for a sheet. In the Row and Column Banding area... the EvDRE is not migrated. If an EvDRE or a report will not be migrated. a text is displayed within this step.. For each Evber].. for example. For each member that is not migrated.. Start reading page axis. The page axis is read. The value below is not migrated: • KEY 44.The migration process starts for the EvDRE. this text appears. 486 2013-09-04 ... Determines the number of reports that will be migrated. There are [number] EVDRE functions detected in the sheet. Start analyzing evdre functions. Following are the main steps. In the Header cell of the Page Axis Formatting area.. For each sheet migrated. In the Data cells. this information is written below this step. Start reading evdre options. The page axis members are read from the ExpansionRange if there is one. If it is set to Y or YES. Valid members are migrated. Indicates the number of EvDREs detected. this text appears.2. DRE. Main Steps displayed in the log Description The Evdre migration for the sheet [SheetName] is starting.Migration Migrated Value Location in the EPM add-in formatting sheet {blank} or ALL PAGEKEY HEADING DATA ODDROWS In the Data and Header cells. In the Header cells of the Row or Column areas or both. a text is displayed within this step. Start reading evdre options.9 Launching the EvDRE Migration Note: You can migrate files with the following formats: xls. Start reading the report 000. The format settings are analyzed. Valid members are migrated.2. Valid members are migrated. you must create in the EPM add-in the connections to the models used in the EvDRE. see Types of Connections.. enter: %temp%/log and open the FPMXLClient. select EPM > More > EvDRE Migration. For each report. xlsm. Connection Before you launch a migration. Note: In this screen. Start reading column axis. The column axis is read and the members are migrated (or not if not recognized). this text appears. see Log File. xlsx.. The report is read. For each member that is not migrated. Indicates that the migration of the sheet has been performed. If no connection has been created on a model used in an EvDRE. The row axis is read. a text is displayed within this step. To migrate EvDREs created with SAP BusinessObjects Planning and Consolidation. For more information about connections in the EPM add-in.. 487 2013-09-04 . Options are migrated. Start reading row axis. Accessing the Log There are two ways of acessing the log: • The latest rows of the log file can be displayed by selecting EPM > More > Log... For each member that is not migrated. the EvDRE is not migrated and the following text is displayed in the log: The application name '{0}' is not valid.Migration Main Steps displayed in the log Description Start reading formatting sheet..dll. a text is displayed within this step... xlt.log file.Migration. in your explorer. The Evdre migration for the sheet [SheetName] is done. errors that are not linked to the migration but to any use of the EPM add-in are also displayed. For more information. • You can also view the whole migration log file. xltx and xltm.. For each option migrated. To do so. 44.. the migrated workbooks do not overwrite the original workbooks. 488 2013-09-04 . the folder you have selected will only contain the migrated workbooks.Migration When launching the migration. simply deselect the Do not move original workbooks in a different folder option. Therefore. You can choose whether the original workbooks and the migrated workbooks will be stored in the same folder or in different ones. you can migrate all the EvDREs at the same time. If there are several EvDREs in a sheet on several models. the folder will contain: the original workbook. And the Migration Copy folder will contain the original workbooks and. using the Do not move original workbooks in a different folder option. you can migrate: • • All the EvDREs on the active worksheet.one log file per workbook. To do so. All workbooks contained in a specified folder (and its subfolders) on your local machine or elsewhere on the network. • • All workbooks contained in a specified folder (and its subfolders) on the Planning and Consolidation server. you can still view the general log of the EPM add-in by selecting EPM > More > Log. Caution: The migration of a worksheet or a workbook can only be performed once. Note: If you select the Planning and Consolidation Server or Local option. the migrated workbook and .5 workbooks before migrating.only for folders that are not on the Planning and Consolidation server . the Change Connection dialog box opens and enables you to select a connection to a model used in the EvDRE. you cannot perform the migration all at once.one log file per workbook. provided that: • All the models are on the same environment. • Alternatively. If there several EvDREs in a sheet on several models that do not have the same environment. select the Do not move original workbooks in a different folder option. Note: • An original workbook is automatically renamed as follows: #Copy of Original#[original name] A file whose name begins with #Copy of Original# cannot be migrated (using the Planning and Consolidation Server or Local option). Selection of the Worksheets and Workbooks to Migrate Using the EvDRE Migration dialog box. • To ensure that each original workbook is kept in the folder you select. All the EvDREs in the active workbook. For this reason. • The connections to all the models used in the EvDRE are created in the EPM add-in. Note: When migrating workbooks on the Planning and Consolidation server. you can also specify that the original workbooks are automatically moved to a dedicated folder called Migration Copy. only for folders that are not on the Planning and Consolidation server . For each workbook. it is recommended that you make a copy of your version 7. a member has been deleted from the database). • If cells appear in yellow. • Once you are sure that you want to validate the migration process. perform a refresh: row and columns containing cells in magenta are deleted. the same structure with the same sub-folders is created. make your modifications and launch the migration again. be sure that you do not want to use these members anymore. Here is what you can do after the migration: • If you have migrated the active worksheet or workbook (using the Active Worsheet or Active Workbook option) and you are not satisfied with the migration: Close your file without saving it. For more information on unrecognized members. • If you have migrated all the workbooks contained in a specified folder (using the Planning and Consolidation Server or Local option) and you are not satisfied with the migration of one or more files: Delete the migrated workbook(s). • You can then delete all the ranges that are linked to the EvDRE and that are not used by the EPM add-in.2. if you move a report in the sheet. Do not delete the cells containing formulas beginning with =EPMOlapMemberO( or =EPMOlapMultiMember( or =EPMInsertedMember(. Otherwise. Open it again. A refresh is not automatically performed after the migration. BeforeRange or AfterRange parameters. colors can be displayed in some cells: • • Cells in magenta indicate that members are not recognized (for example.10 After Migration Once you have performed an EvDRE migration. indicating unrecognized members. Cells in yellow contain EPM functions after the migration of the MemberSet. Make a copy of the original workbook(s). move the EPM functions to other cells in the sheet and do not delete them.Migration • A migrated workbook is automatically named with the original name. perform the following actions: • If cells appear in magenta. Rename the worbook(s). 44. indicating EPM functions. always leave a blank row or column between a function and a report. the functions will also be moved. 489 2013-09-04 . • If you are satisfied with the migration. it is recommended that you move the function above all the reports. Also. Note: However. Make your modifications and launch the migration again. deleting the prefix #Copy of Original# (to be able to launch a migration again). Note: • • If there are sub-folders. do not delete cells in yellow. see RowKeyRange and ColKeyRange Members and PageKeyRange Members. Caution: So that the migrated reports continue to function. Tip: • If you want to use a report as a template using any Planning and Consolidation connection. • 490 2013-09-04 . For more information. then select EPM > Edit Report > Options and select the Do not Store Connection option. select a cell in the report. see Use as Input Form. select a cell in the report. For more information. see Do not Store Connection and Do not Store Environment in the Connection.Migration Note: If outside the reports certain format settings remain from the EvDRE. then select EPM > Edit Report > Options and select the Use as an Input Form option. You can then refresh the reports and the migrated formatting will be applied. you can use the standard Microsoft Office Excel feature to delete the formatting. If a report was used before migration as an input form. com/irj/sdn/businessobjects-sdklibrary 491 2013-09-04 . Customers with a maintenance agreement have an authorized user ID to access this site. upgrade and migration guides.More Information More Information Information Resource Location SAP BusinessObjects product information http://www.sap.sap.sap.sdn. These guides are listed on the Help Portal accompanied by a link to the SAP Service Marketplace. Certain guides are stored on the SAP Service Marketplace and are not available from the SAP Help Portal.com/releasenotes SAP Help Portal SAP Service Marketplace The SAP Service Marketplace stores certain installation guides.com/businessobjects and on the "SAP BusinessObjects Overview" side panel click All Products.sap. To obtain an ID. contact your customer support representative.sap. https://boc. If you are redirected to the SAP Service Marketplace from the SAP Help Portal. Customers with a maintenance agreement have an authorized user ID to access this site. http://service. https://cw. and an interactive feedback channel.sap. deployment guides.sap.sdn. You can download PDF versions or installable HTML libraries. You can access the most up-to-date documentation covering all SAP BusinessObjects products and their deployment at the SAP Help Portal. Contact your customer support representative to obtain an ID.sdn.com/ Developer resources https://www. release notes and Supported Platforms documents.com/bosap-instguides Release notes: http://service. use the menu in the navigation pane on the left to locate the category containing the documentation you want to access.sap. a collaborative authoring environment.com/bosap-support > Documentation • • Installation guides: https://service.com Navigate to http://help.com/cw/community/docupedia Docupedia Docupedia provides additional documentation resources. com/irj/boc/businessobjects-articles These articles were formerly known as technical papers.sap.sdn. database design tools. contact your customer support representative.sap. Expertise is available in topics such as relational and multidimensional databases. connectivity.sap. Customers with a maintenance agreement have an authorized user ID to access this site.com/services/bysubject/businessobjectsconsulting Consulting Consultants can accompany you from the initial analysis stage to the delivery of your deployment project. 492 2013-09-04 .sap. we can offer a training package to suit your learning needs and preferred learning style.com/bosap-support Online customer support The SAP Support Portal contains information about Customer Support programs and services.sap. Forums on the SAP Community Network https://www. http://www. To obtain an ID. and customized embedding technology.sdn.sap. It also has links to a wide range of technical information and downloads.More Information Information Resource Location SAP BusinessObjects articles on the SAP Community Network https://www. https://service. http://service.com/irj/scn/forums http://www.com/notes Notes These notes were formerly known as Knowledge Base articles.com/services/education Training From traditional classroom learning to targeted e-learning seminars. Index A active connection 29 add-in installation 25 re-activate 26 asymmetric report create 101 auto completion 84 autofill 83 axes switch 156 custom member create 176 delete 179 enable. disable 179 export 180 import 181 manage 175 modify 179 order 177 formatting (continued) dynamic. insert 197 comment create 285 display in a cell 286 modify 285 search 287 connection active 29 book publication actions 212 distribution actions 212 local 29 migration actions 487 open and save actions 49 Planning and Consolidation 29 SAP BusinessObjects Enterprise 29 select 30 store in report 108 context 55 conversion files 368 K keywords 368 L language application. define template 199 dynamic. by properties 91 D data change work status 290 collect 229 filter 111 input 279 rank 113 read-only 114 refresh 131 save to server 288 sort 109 validate 289 dimension place in page axis. define 199 I INFO instructions 326. 341 INFO instructions. adding 342 INFO instructions. presentation 199 G group member. using Report Editor 78 distribution connection 212 launch 227 template 223 drill-through to table 167 to URL 167 dynamic chart insert 197 dynamic formatting apply 203 presentation 199 template. by properties 93 flash object create 183 insert 196 formatting dynamic. using Report Editor 80 place. manage 175 enter in a cell 81 enter using Member Selector 85 exclude 164 exclude. select 465 data. multi-ling 342 input form enter data 279 publish to web portal 211 insert members 97 installation 25 B blank column insert 82 blank row insert 82 book publication connection 212 launch 219 template 213 Business Process Flow 293 J journals open view 291 C cache activate 297 chart dynamic. select 465 local member 115 log file 298 log off 27 log on 27 logic 344 F filter data 111 member. dynamically 123 493 2013-09-04 . apply 203 M member collapse 160 custom. create 103 publish to web portal 211 S sheets created automatically 205 sort data 109 member. properties 323 packages. connection 212 book.Index member (continued) expand 156 filter by properties 93 group by properties 91 identification 73 insert 97 keep 163 local 115 name to display 88 properties. scheduling 345 PowerPoint add-in features 301 U update 25 W wild cards 368 Word add-in features 301 work status change 290 494 2013-09-04 . create 101 create manually 81 create using copy/paste 98 create using the pane 74 create using the Report Editor 76 delete 129 highlight 129 layout rules 59 move 80 options 107 ownership-based hierarchies. launch 219 book. adding 324 packages. definition 305 packages. by properties 91 O offline mode 207 P package descriptions 307 package link 347 package list 345 package. template 213 Q quick link create 171 report (continued) refresh 131 several reports 127 shift 80 store connection 108 Report Editor create report 76 insert shift 80 move 80 place dimension 78 place dimension in page axis 80 select member 79 R rank data 113 refresh data 131 report 131 report asymmetric. display 74 rename 123 select using Member Selector 85 select using Report Editor 79 sort by properties 91 member recognition activate 84 presentation 81 process chain. definition 306 process chain. FTP 322 publication book.