How to Call BPC Data Manager Package From Visual Basic

5/28/2018 How to Call BPC Data Manager Package From Visual Basic

SAP COMMUNITY NETWORK scn.sap.com 2012 SAP AG 1

How to Call BPC Data ManagerPackage from Visual Basic

Applies to:

SAP BusinessObjects Planning and Consolidation version 10 for NetWeaver

BPC 10 SP7 & Above

EPM Add-In 10.0 SP 12 Patch 1 for .NET

Summary

How to call BPC data manager package from Visual Basic

Author:Tristan Colgate, Amaury Gruyelle, Muthu Ranganathan

Company: Bluefin Solutions in collaboration with SAP

Created on:31 August 2012

Author Bio

Tristan Colgate, EPM Lead at Bluefin Solutions, UK

Amaury Gruyelle, BPC Consultant at Bluefin Solutions, UK

Muthu Ranganathan, EPM Product Management at SAP.


How to Cal l BPC Data Manager Package from VisualBasic


Table of Contents

Scenario .............................................................................................................................................................. 3Details and Usage .............................................................................................................................................. 6Step by Step Instructions .................................................................................................................................... 7

Create the PARAMETERS Excel Name Range ............................................................................................. 7 Create the PACKAGE Excel Name Range ................................................................................................... 12

Add the Visual Basic code ............................................................................................................................ 15Create the User Interface to perform the Copy ............................................................................................. 18

Appendix ........................................................................................................................................................... 21How to display the Developer tab in the Excel Ribbon ................................................................................. 21

MS Office Excel 2010 ................................................................................................................................................ 21VBA Code ..................................................................................................................................................... 24Example XML Prompt File ............................................................................................................................ 31

Related Content ................................................................................................................................................ 33Copyright........................................................................................................................................................... 34




Scenario

The Data Manager packages delivered as standard with BPC are sophisticated, having many differentoptions. Consider the Copy DM Package.

Firstly, the user needs to specifyhow the records are handledduring the copy.

Then the user specifies whetherthey want default logic to run afterthe copy is performed.




Thirdly the user is asked whetherthey wish the copy to respectwork status.

Fourthly, they must specify thesource and destination dataranges.




Finally, the user selects whetherthey want to run the copyimmediately, or schedule it to runlater.

These options can be confusing to an occasional user of BPC, such as a Cost Centre Manager preparingtheir annual budget. Many of the options are not relevant to what they are trying to achieve, and wouldactually cause errors in the way their data is processed if set incorrectly.

One solution is to copy the standard package and amend the Prompt script to default those options whereappropriate and only present options that are pertinent to the user, in contextualised language that the userwill understand.

This may, however, still leave the user navigating through a number of screens when they simply wish to

perform a simple function, such as copying their data from one version to another. A common question fromusers in such a scenario is whether they can simply have drop-down boxes in two cells in the Excelspreadsheet where they can specify from and to Categories, and a button that executes the copy:




This paper will describe how to achieve this.

Details and Usage

The solution involves the following components.

An Excel sheet where theuser can specify fromand to versions and clickthe button to execute thecopy.

A Name range calledPARAMETERSin theExcel Workbook thatspecifies all of theparameters that thefunction in question (inour case, the Copyfunction) expects, alongwith the values that willbe passed to them.




A Name range calledPACKAGE in the Excelworkbook that defines thedetails of the package wewish to execute.

We also specify here thename of the Prompt Filethat is generated duringthe process.

Visual Basic code that, upon being invoked, calls the Data Manager Package specified in thePACKAGEName range, passing the parameters specified in the PARAMETERSName range.

Step by Step Instructions

Create the PARAMETERS Excel Name Range

The standard CopyDM Package delivered in the EnvironmentShell BPC model expects the followingparameters (as defined in the prompt script file).

TARGETMODE contains a 0 or a 2 RUNLOGIC contains a 0 or a 1

CHECKLCK contains a 0 or a 1

SELECTION Dimension/ Member pairs defining the source data range.

TOSELECTION Dimension/ Member pairs defining the target data range.

This information can be gleaned by looking at the DM Package prompt script file, which is accessed asfollows:

Navigate to the DataManagertab on the Excel ribbon




Select Organize-->OrganizePackage List

In the Organize Package Listpop-up, find the CopyPackage, right-click andchoose Modify Package.

Click on Modify Scriptin thesubsequent pop-up:




Click onAdvancedin the

subsequent pop-up:

The final popup, Modify Script,shows the script used to passparameters back to the DMPackage Process Chain.Analyse this information towork out which parametersyou need to include in thePARAMETERSExcel Name

Range.

Now we will create the PARAMETERS Name range in Excel.




Create the cells containing thespecification of parameters asper the screenshot. Note:

Prompt names shouldmatch those in the DM

Prompt definition, with %before and after.

Prompt Type is eitherParameter orStringListPairs

Dimension is only relevantfor StringListPairs

Value is the value youwant to set this parametertothis can be hardcoded (as is the case forthe three Parameters), orcan use an Excel formula,

as is the case for thesource and destinationcategories which look atthe selection the user hasmade in the from and toversion drop-downs.




Select the cells (in our case,the range A1 to D20)

Enter PARAMETERSinto thecell reference box to make theName range.




Create the PACKAGE Excel Name Range

Log on to the NetWeaverABAP stack via SAPGUI.

Go to transaction SE16 (DataBrowser)

Details about Data Packagesare stored in tableUJD_PACKAGES2. Enter thistable name into the TableNamefield and click on:




Enter the BPC Environmentand Model IDs into theAPPSET_ID and APP_IDfields respectively.

Click on:

In the table returned, identifythe row containing the DMPackage we are interested inand select it.

Click on:

The resulting screen containsall of the details you will needto populate the PACKAGEname range.

The following table indicates how you should map the values found in the UJD_PACKAGE2 table with thefields you need to populate in the Excel Name Range you will shortly create.




Field from table UJD_PACKAGES2 Field in Excel Name Range Example

CHAIN_ID Filename /CPMB/COPY

GROUP_ID GroupId Data Management

PACKAGE_ID PackageDesc Copy

PACKAGE_ID PackageId Copy

PACKAGE_TYPE PackageType Process Chain

TEAM_ID TeamID

USER_GROUP UserGroup* 0010

* Note that the number in the table must be entered with leading zeroes, as a four character field.

Additionally, field PromptFilewill contain the name of a file that will be created as part of the process oflaunching the DM Package. Note that, if you are using this in an Enterprise environment, that youll need todecide on a file location that can be guaranteed to exist on all end users PCs. In our, example we use:

C:\CopyDataManagerPromptFile.txt

Now we will create the Excel PACKAGE Name Range:

Create the cells containing thespecification of parameters asper the screenshot.




Select the cells in the datarange (in our case cellsF1:G9)

Enter PACKAGEinto the cellreference and hit .

Add the Visual Basic code

Note that you must have the Developer tab enabled in the Excel ribbon:




If you cannot see this tab in your ribbon in Excel, then you need to enable it. Follow the instructions in theAppendix to do so before moving on.

Click on the button in theDeveloper ribbon tab to open

the Visual Basic editor.

Navigate to Tools-->

References from the VisualBasic menu bar.




Check the boxes as per the

screenshot to the right. Noteyou may need to scroll downquite a long list to find some ofthese.

In the Project Explorerpane,right click on the VBAProjectnode for your Excel Workbookand choose:

Insert --> Module




Copy and Paste the code in

Appendix 4.x into the newlycreated Module.

Create the User Interface to perform the Copy

Create the following cells.




Use Data Validationin order toprovide a drop-down on theCategory dimension fields.

In the Developerribbon tab, choose

Insert-->Button Form Control

Use the lasso tool to draw out therectangle for the button.




TheAssign Macropopup appears.Select existing MacroexecuteDmPackageWithParameter

s.

Click OK.

The button is now displayed. Totest the solution, click on the button.

In the Data Managerribbon tab,

click on:




The Package Status popup shouldappear and show your job inprogress (or perhaps alreadycompleted).

Appendix

How to display the Developer tab in the Excel Ribbon

MS Office Excel 2010

Here is the Excel 2010 Ribbon. Note that the Developertab is not currently displayed.




Select the File tab in the ribbonand click on Options.

The Optionspop-up isdisplayed:




Select the Customize Ribbonoption in the left pane.

In the right-hand panel, selectthe checkbox labelledDeveloper, and then click onOK.

The Developertab is now

displayed.




VBA Code

Public Sub executeDmPackageWithParameters()

' Create the Answer Prompt file in the location

' specified in the Name Range "PACKAGE"

createAnswerPromptFile "PACKAGE", "PARAMETERS"

' Get the DM Automation class instance

Dim objDMautomation As EPMAddInDMAutomation

Set objDMautomation = New EPMAddInDMAutomation

' Run the package specified in Excel Name Range "PACKAGE",

' using the promtp file specified in Name Range "PACKAGE"

objDMautomation.RunPackage objPackageFromSheet("PACKAGE"), _

strFilename("PACKAGE")

End Sub

Private Function strFilename(strRange As String) As String

' Get the range in which the DM package paramteres is set

Dim rngPackageRange As Range

Set rngPackageRange = Application.Names(strRange).RefersToRange

' Loop through the rows

For i = 1 To rngPackageRange.Rows.Count

If rngPackageRange(i, 1).Value = "PromptFile" Then

strFilename = rngPackageRange(i, 2).Value

Exit Function

End If

Next

End Function

Private Function strPackageDescription(strRange As String) As String









If rngPackageRange(i, 1).Value = "PackageId" Then

strPackageDescription = rngPackageRange(i, 2).Value

Exit Function

End If

Next

End Function

Private Function objPackageFromSheet(strRange As String) As ADMPackage




' Create the ADM Package object

Set objPackageFromSheet = New ADMPackage



Select Case rngPackageRange(i, 1).Value

Case "Filename"

objPackageFromSheet.Filename = rngPackageRange(i, 2).Value

Case "GroupId"

objPackageFromSheet.GroupId = rngPackageRange(i, 2).Value

Case "PackageDesc"

objPackageFromSheet.PackageDesc = rngPackageRange(i, 2).Value

Case "PackageId"

objPackageFromSheet.PackageId = rngPackageRange(i, 2).Value

Case "PackageType"

objPackageFromSheet.PackageType = rngPackageRange(i, 2).Value

Case "TeamId"

objPackageFromSheet.TeamId = rngPackageRange(i, 2).Value

Case "UserGroup"

objPackageFromSheet.UserGroup = rngPackageRange(i, 2).Value

End Select




Next

End Function

Private Sub createAnswerPromptFile(strPackageName As String, _

strParametersName As String)

' Create a new XML document

Dim objDOM As DOMDocument

Set objDOM = New DOMDocument

' Set the processing instruction of the XML document

Dim objProcessingInstruction As IXMLDOMProcessingInstruction

Set objProcessingInstruction = _

objDOM.createProcessingInstruction("xml", _

" version='1.0' encoding='utf-16'")

objDOM.appendChild objProcessingInstruction

' Create root element

Dim objRootElem As IXMLDOMElement

Set objRootElem = objDOM.createElement("ArrayOfAnswerPromptPersistingFormat")

objDOM.appendChild objRootElem

' XSI Attribute

Dim objMemberRel As IXMLDOMAttribute

Set objMemberRel = objDOM.createAttribute("xmlns:xsi")objMemberRel.NodeValue = "http://www.w3.org/2001/XMLSchema-instance"

objRootElem.setAttributeNode objMemberRel

' XSD Attribute

Set objMemberRel = objDOM.createAttribute("xmlns:xsd")

objMemberRel.NodeValue = "http://www.w3.org/2001/XMLSchema"

objRootElem.setAttributeNode objMemberRel

' Get the range of cells containing the parametersDim rngParameters As Range

Set rngParameters = ThisWorkbook.Names(strParametersName).RefersToRange

'Excel.Names(strParametersName).RefersToRange

'

Dim objCurrentStringPairParent As IXMLDOMElement




' Loop through each row

For i = 1 To rngParameters.Rows.Count

' See which type of parameter is being passed

Select Case rngParameters(i, 2).Value

' If it is a single Parameter, then add a parameter node to the root node

Case "Parameter"

addSingleSelectionParameterToXML rngParameters(i, 1).Value, _

rngParameters(i, 4).Value, _

objRootElem, _

objDOM

' If it is a list of values

Case "StringListPairs"

' If it's a new set of String List Pairs, then create a new parent

If rngParameters(i, 1).Value strCurrentStringPair Then

strCurrentStringPair = rngParameters(i, 1).Value

Set objCurrentStringPairParent = _

getStringListPairParent(rngParameters(i, 1).Value, _

objRootElem, _

objDOM)

End If

' Add the Dimension Name and Value to the parent

addStringListPair rngParameters(i, 3).Value, _

rngParameters(i, 4).Value, _objCurrentStringPairParent, _

objDOM

End Select

Next

' Create the File object

Dim objFile As FileSystemObjectSet objFile = New FileSystemObject

' Create a stream to create and write to the file

Dim objStream As TextStream

Set objStream = objFile.OpenTextFile(strFilename(strPackageName), _

ForWriting, True)




' Write the name of the DM package first and then the XML output

objStream.WriteLine strPackageDescription(strPackageName) & _

"{param_separator}" & _

objDOM.XML

' Close the file

objStream.Close

End Sub

Private Function addStringListPair(strVariableName As String, _

strValue As String, _

objParent As IXMLDOMElement, _

objDOM As DOMDocument)

' Create the "StringListPair" node

Dim objStringListPairElement As IXMLDOMElement

Set objStringListPairElement = _

objDOM.createElement("StringListPair")

objParent.appendChild objStringListPairElement

' Create the "Str" element containing the variable name

Dim objStrElement As IXMLDOMElement

Set objStrElement = objDOM.createElement("str")

objStringListPairElement.appendChild objStrElementobjStrElement.Text = strVariableName

' Create the "lst" element

Dim objLstElement As IXMLDOMElement

Set objLstElement = objDOM.createElement("lst")

objStringListPairElement.appendChild objLstElement

' Create the "string" element containing the variable value

Dim objStringElement As IXMLDOMElement

Set objStringElement = objDOM.createElement("string")objLstElement.appendChild objStringElement

objStringElement.Text = strValue

End Function

Private Function getStringListPairParent(strVariableName As String, _


objDOM As DOMDocument) As IXMLDOMElement




' Create the "AnswerPromptPersistingFormat" node

Dim objAnswerPromptPersistingFormatElement As IXMLDOMElement

Set objAnswerPromptPersistingFormatElement = _

objDOM.createElement("AnswerPromptPersistingFormat")

objParent.appendChild objAnswerPromptPersistingFormatElement

' Create the "_ap" node

Dim objApElement As IXMLDOMElement

Set objApElement = objDOM.createElement("_ap")

objAnswerPromptPersistingFormatElement.appendChild objApElement

' Create the parameter name element

Dim objParameterElement As IXMLDOMElement

Set objParameterElement = objDOM.createElement("Name")

objApElement.appendChild objParameterElement

objParameterElement.Text = strVariableName

' Create the values element

Dim objValuesElement As IXMLDOMElement

Set objValuesElement = objDOM.createElement("Values")

objApElement.appendChild objValuesElement

' Create the "_apc" node

Set getStringListPairParent = objDOM.createElement("_apc")

objAnswerPromptPersistingFormatElement.appendChild getStringListPairParent

End Function

Private Function addSingleSelectionParameterToXML(strVariableName As String, _

strValue As String, _


objDOM As DOMDocument)

' Create the "AnswerPromptPersistingFormat" node

Dim objAnswerPromptPersistingFormatElement As IXMLDOMElement

Set objAnswerPromptPersistingFormatElement = _

objDOM.createElement("AnswerPromptPersistingFormat")objParent.appendChild objAnswerPromptPersistingFormatElement

' Create the "_ap" node

Dim objApElement As IXMLDOMElement

Set objApElement = objDOM.createElement("_ap")

objAnswerPromptPersistingFormatElement.appendChild objApElement




' Create the parameter name element

Dim objParameterElement As IXMLDOMElement

Set objParameterElement = objDOM.createElement("Name")

objApElement.appendChild objParameterElement

objParameterElement.Text = strVariableName

' Create the values element

Dim objValuesElement As IXMLDOMElement

Set objValuesElement = objDOM.createElement("Values")

objApElement.appendChild objValuesElement

' Create the string element with the value passed to the parameter

Dim objStringElement As IXMLDOMElement

Set objStringElement = objDOM.createElement("string")

objValuesElement.appendChild objStringElement

objStringElement.Text = strValue

End Function




Example XML Prompt File




Related Content

Enterprise Performance Management Community

Financial Excellence Community
http://scn.sap.com/community/epmhttp://scn.sap.com/community/epmhttp://scn.sap.com/community/epm/financial-excellencehttp://scn.sap.com/community/epm/financial-excellencehttp://scn.sap.com/community/epm/financial-excellencehttp://scn.sap.com/community/epm




Copyright

Copyright 2012 SAP AG. 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.

Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.

IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9,iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server,PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes,BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX,Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe SystemsIncorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks ofCitrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts

Institute of Technology.

Java is a registered trademark of Oracle Corporation.

JavaScript is a registered trademark of Oracle Corporation, used under license for technology invented and implemented by Netscape.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentionedherein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.

Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, andother Business Objects products and services mentioned herein as well as their respective logos are trademarks or registeredtrademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company.

All other product and service names mentioned are the trademarks of their respective companies. Data contained in this documentserves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAPGroup") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors oromissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in theexpress warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting anadditional warranty.

Documents

How to Call BPC Data Manager Package From Visual Basic