EPM Plug-in User Guide

What's New

What's New in EPM Plug-in Support Package 01

What's New in EPM Plug-in 2.1

Introduction to the EPM Plug-in

Installation and Re-activation

Installation

Re-activating the EPM plug-in

Logon and Connections

Logging On and Off

Connection Management

Active Connection for the Current Sheet

Types of Connections

Connections and Data Source Mapping

SAP BW (INA Provider) Connections

Disconnecting a Data Source (Model, Cube or Query)

Selecting Connections

Selectively connecting or disconnecting sheet/connection pairs

Changing Connections

Large Volume Data Sources

Restrictions on Specific Features

Drill-Through

About the EPM Plug-in Interface

Main Interface Areas

Performing Actions without the Mouse

Using Microsoft Office 2003

Features Available

Security on Members

Open and Save a File

Open a Report when Dimensions or Members have Changed

Open a File from a Web Portal

Open and Save a File from/to a Server

Open and Save Connection

Open Actions

Save Actions

Open and Save Dialog Box Description and Actions

Server Folder Structure

Context

Context Favorites

Context Display Options

Report Layout Rules

Overall Layout Rules

Basic Layout Rules

Dimension Layout Restrictions

Page Axis

Row Axis

Simple Row Axis

Multidimensional or Nested Row Axis

Asymmetric Row Axis

Row Axis Restrictions

Column Axis

Simple Column Axis

Multidimensional or Nested Column Axis

Asymmetric Column Axis

Column Axis Restrictions

Data Grid Considerations

Data Grid Important Tips

Report Creation

Reports Based on BW Queries

BW Queries with Variables

Member and Cell Identification and Properties

Member Identification

Member and Cell Properties

Report Creation using the EPM Pane

Report Creation using the Report Editor

Report Editor's Layout Tab Presentation

Dimension Placement in the Report Editor

Member Selection in the Report Editor

Position of each Dimension in the Page Axis using the Report Editor

Report Move in the Sheet using the Report Editor

Shift Insertion Between the Data Grid of the Report and its Row and Column Axis

Report Creation Directly in a Sheet

Member Recognition

Member Entry Directly in a Sheet

Blank Row and Column Insertion

Microsoft Office Excel Formula Entry Directly in a Sheet

Auto Fill

Auto Completion in Nested Axes

Member Entry Using the Member Selector

Member Selector Presentation

Member Selection

Member Selection by Properties and Named Ranges

Blank Member

Member Name to Display

Selection Relationship

Hierarchy Levels to Display

Member Sorting and Grouping by Properties

Member Filtering by Properties

Page Axis Dimension Members Modification using the Member Selector

Member Entry Using the Member Selector (on Large Volume Data Sources and Specific Connections)

Member Entry Using the Insert Members Dialog Box

Report Creation using Copy/Paste

Asymmetric Report Creation

Ownership-based Hierarchies

Time-Dependent Hierarchies

Actions and Options Specific to the Current Report

Report Options

Freeze Data Refresh

Display only Base Level Data

Do not Store Connection and Do not Store Environment in the Connection

Query Options

Data Sorting, Ranking and Filtering

Local Member Automatically Detected

Local Member Creation

Local Members - Examples

Renaming Members

Excluding Members

Member Insertion Filtering

Microsoft Excel Features for Report Layout

Ad-hoc Data or Member Sorting

Several Reports in a Sheet

Restrictions with Several Reports in a Sheet

Excel Formula Options Prerequisites

User Options

Sheet Options

General Sheet Options

Expand Options

Use as Input Form

Member Recognition Activation

Worksheet Type

Totals Placement

No Data and Zero Values

Show as Microsoft Excel Comments

Formatting Sheet Options

Row Header Indentation

Display Name

Auto Fit Column Width

Repeat Row Headers and Repeat Column Headers

Display Dimension Names

Empty Cell Default Value

Member not Found Default Value

Apply Dynamic Formatting

Refresh Sheet Options

Keep Formula on Data and Show Source Data in Comments

Calculate Parents in Hierarchies

Refresh Data on the Whole File when Opening it

Clear Data on the Whole File when Saving it

Apply only Report Editor Definition for Faster Refresh

Restore Dynamic Selection on Refresh after Navigation

Keep Formulas Static that Reference Report Cells

Report Navigation

Going Back in the Navigation Actions

Row and Column Axes Switch

Expand

Expand on Nested Axis

Collapse

Collapse on Nested Axis

Creating custom members

Custom Members Order

Modifying Custom Members

Enabling or Disabling all the Custom Members Defined for a Sheet/Connection

Deleting Custom Members

Custom Members Export

Exporting Custom Members

Custom Members Import

Importing Custom Members

Dynamic Charts

Dynamic Formatting

Dynamic Formatting Template Definition

Defining a Dynamic Formatting Template

Dynamic Formatting Applied to a Worksheet or to a Specific Report

Applying a Default Dynamic Formatting Template to the Worksheet

Applying a Default Dynamic Formatting Template to a report

Workbook Sheet Automatic Generation

Offline Mode

Worksheet Protection

Collaboration

Report Publication to a Web Portal

Publication and Distribution Connection

Book Publication

Book Publication Template

Creating Publication Templates for Local, SAP BusinessObjets Enterprise, SAP BW (INA Provider) Connections

Creating Publication Templates for a Planning and Consolidation connection

Book Publishing

Launching Book Publication

Scheduling Book Publication

Distribution and Data Collection

Distribution Template

Creating Distribution Templates

Workbook Distribution

Launching Distribution

Scheduling Distribution

Data Collection

Collecting Data

EPM Functions

Connection Name Parameter - Syntax

EPMInsertCellsBeforeAfterBlock

EPMMemberID

EPMReportOptions

EPMMemberSortingOverride

EPMDimensionPropertyValues

EPMSelectMultiMemberID

EPMCellRanges

EPMRefreshTime

EPMScaleData

EPMDriverBasedRefresh

EPMRetrieveData

EPMDimensionList

EPMDimensionSelection

EPMCommentFullContext

EPMCommentPartialContext

EPMCellContextDocument

EPMExecuteAPI

Data Input and Save

Data Input

Data Input - Planning and Consolidation Connections

Data Input - SAP BW (INA Provider) Connections

Spread, Trend and Weight Features

Comment Creation and Modification

Comment Display in a Cell

Comment Search

Data Save

Data Save - Planning and Consolidation Connections

Data Transfer and Save - SAP BW (INA Provider) Connections

Business Process Flows

Report and Input Form Templates

EPM Plug-in for Microsoft Office PowerPoint

Common Features to the Plug-in for Microsoft Office Excel and PowerPoint

Additional Features in the Plug-in for Microsoft Office PowerPoint

Options in the Plug-in for Microsoft Office PowerPoint

About the Data Manager Connection

Standard Packages

Standard Data Management Packages

Examples of Standard Data Management Packages

Copy Example

Move Example

Import Transaction from a Data File Example

Import Master Data from a Data File Example

Load Process Chain Examples

Financial Process Packages

System Administration Packages

Additional Packages

About Additional Packages

Example Packages

About the Import and Send Email Process Chain

Using the SendMail Process Chain

Using the FTP Process Chain

Importing Transaction Data from an Information Provider

Adding or Modifying Packages

Package Properties

Adding Packages - version for Microsoft

Adding Packages - version for NetWeaver

Adding an Example Process Chain as a Package

Modifying Packages - version for Microsoft

Modifying Packages, version for NetWeaver

Customizing Packages

Predefined Constants

Prompt Commands

About Prompt Commands

Dynamically Passing Text to Logic

Modifying Prompt Package Commands

CHECKBOX Prompt() Command

CHECKBOXGROUP Prompt() Command

COMBOBOX Prompt() Command

CONVERSION Prompt() Command

COPYBOXNO Prompt() Command

TRANSFORMATION Prompt() Command

SELECT Prompt() Command

DELIMITER Prompt() Command

SELECTINPUT Prompt() Command

INFILE Prompt() Command

TEXT Prompt() Command

SELECTION Prompt() Command

OUTFILE Prompt() Command

COPYMOVEINPUT Prompt() Command

COPYMOVE Prompt() Command

COPYBOXYES Prompt() Command

INFILES Prompt() Command

LOGICFILE Prompt() Command

MESSAGE Prompt() Command

RADIOBUTTON Prompt() Command

SELECTIONFILE Prompt() Command

MEMBERFROMTOINPUT Prompt() Command

INFO Instructions

About INFO Instructions

Adding INFO Instructions to a Package

Multi-line INFO Instructions

Dynamic Constants

Logic Use in Packages

Package Object Syntax

Data Manager Tasks

Removing a Package from the List

Running Packages

Scheduling Packages

Running a Copy Package

Defining a Package Link

Running a Package Link

Modifying the List of Selected Packages

Viewing Package Status

Viewing Package Schedule Status

Adding Multiple Process Chains to a Package

Importing and Exporting Data Having Multiple Key Figures

Retracting Master Data and Transaction Data

About Delta Initialization

Organizing Delta Initialization

Modifying a Delta Initialization

Running the Delta Initialization

Data Transformations and Conversions

About Data Transformations

Defining a Transformation File

Transformation File: Options

Transformation File: Mapping Function

Transformation File: Conversion Section

Sample Transformation File

Data Conversions

Creating, Validating, and Copying Conversion Files

Keywords and Wildcards Used in Data Conversions

Data Transfer and Preview

About Data Transfer and Preview

Uploading or Downloading Data

Downloading a Text File from the Database

ConnectionString Parameter - Syntax

Macros

Context

SetContextOptions

SetContextOptionsForSeveralDimensions

AddContextFavorite

UpdateContextFavorite

DeleteContextFavorite

SelectContextFavorite

ChangeReportConnection

RefreshConnectionMetadata

SetStaticActiveConnection

SetActiveConnectionForOpenedFiles

RemoveMemberFromRowAxis

GetRowAxisDimensionCount

GetRowAxisMembers

GetRowAxisOwner

AddMemberToColumnAxis

RemoveMemberFromColumnAxis

GetColumnAxisDimensionCount

GetColumnAxisMembers

GetColumnAxisOwner

AddMemberToPageAxis

RemoveMemberFromPageAxis

GetPageAxisMembers

GetUnrecognizedMembers

GetPageAxisOwner

OpenMemberSelector

OpenFilteredMemberSelector

GetActiveReportName

GetAllReportNames

GetDataBottomRightCell

GetChildrenFromMember

DisplayFormattingSheets

DisplayLog

Get MDX Request

ClearMetadataCache

Book Publication and Distribution

SetActiveBooksConnection

GetActiveBooksConnection

OpenDistributionWizardOnSpecificTemplate

OpenBookPublicationWizardOnSpecificTemplate

Open/Save Connections

SetActiveFileManagementConnection

GetActiveFileManagementConnection

SAP BW (INA Provider) Connections

UnloadInactiveQueries

ExecuteDefaultReport

SetQueryVariables

GetQueryVariableValue

RefreshConnectionMasterData

GetAccessMode

SetAccessMode

TransferWorksheetData

TransferWorkbookData

RollbackData

Planning Objects

ExecutePlanningFunction

ExecutePlanningSequence

SetPlanningFunctionVariable

SetPlanningSequenceVariable

SetPlanningFunctionFilter

Data Manager

GetActiveDataManagerConnection()

SetActiveDataManagerConnection(string connectionString)

DataManagerFilesUpload

Macros used in EPMExecuteAPI function

LogOn

Connections

OpenConnectionManager

OpenPowerPointPresentation

OpenFindCommentsEditor

Open/Save from Server

OpenServerInputFormFolder

OpenServerReportFolder

OpenServerRootFolder

SaveToServerRootFolder

OpenDimensionAndMemberSelector

OpenCommandDisplayOptions

ShowHidePaneAndContext

Refresh

RefreshReportDataOnly

RefreshActiveReport

RefreshActiveSheet

RefreshActiveWorkBook

Save Data

SaveWorksheetData

SaveWorkbookData

SaveAndRefreshWorksheetData

SaveAndRefreshWorkbookData

SaveWorksheetDataWithoutCache

SaveWorkbookDataWithoutCache

SaveAndRefreshWorksheetDataWithoutCache

SaveAndRefreshWorkbookDataWithoutCache

OpenWorkStatusEditor

Spread, Trend, Weight

CreateBookPublicationTemplate

OpenBookPublicationTemplate

ValidateBookPublicationTemplate

SaveAsBookPublicationTemplate

SaveBookPublicationTemplate

OpenBookPublicationWizard

Distribution and Collection

CreateDistributionTemplate

OpenDistributionTemplate

ValidateDistributionTemplate

SaveAsDistributionTemplate

SaveDistributionTemplate

OpenDistributionWizard

OpenCollectionWizard

OpenSpecificDocument

OpenSpecificDocumentByModule

Data Manager

DataManagerClearSavedPromptValues()

DataManagerCreateConversionFile()

DataManagerCreateConversionSheet()

DataManagerCreateNewTransformationSheet()

DataManagerOpenConversionFileDialog()

DataManagerOpenDataPreviewDialog()

DataManagerOpenFileDownloadDialog()

DataManagerOpenFileUploadDialog()

DataManagerOpenOrganizePackageDialog()

DataManagerOpenRunPackageDialog()

Data ManagerOpenRunPackageLinkDialog()

DataManagerOpenScheduleStatusDialog()

DataManagerOpenTransformationFileDialog()

DataManagerOpenViewLinkStatusDialog()

DataManagerOpenViewStatusDialog()

DataManagerRunPackage(packageId As String, groupId As String, teamId As String, fileName As String)

DataManagerRunPackageLink

DataManagerValidateConversionFileDialog()

DataManagerValidateServerTransformationFileDialog()

DataManagerValidateTransformationFileDialog()

Assigning a Control Form to a Macro

Custom VBA Functions (Events)

Ribbon Extensibility

Ribbon Extensions: Simple Method

RibbonXML.xml Content

VBA Macro Association

Ribbon Extension Example

Ribbon Extensions: Advanced Method

How to Create a Ribbon Extension

Interface Implementation Details

Properties

Methods

List<EpmRibbonAction> GetRibbonComponents();

List<FPMXLClient.RibbonUtilies.Tab>GetAdditionalTabComponent();

List<AddInCommand> GetCustomCommands();

void RibbonOnAction(IRibbonControl ribbonControl);

string GetExtensionDescription();

string GetNameForEpmCoreRibbon();

string RibbonGetContent(IRibbonControl ribbonControl);

string RibbonGetLabel(IRibbonControl ribbonControl);

string RibbonGetDescription(IRibbonControl ribbonControl);

string RibbonGetKeyTip(IRibbonControl ribbonControl);

void RibbonOnActionToggle(IRibbonControl ribbonControl, bool isPressed);

bool RibbonGetEnabled(IRibbonControl ribbonControl);

IPictureDisp RibbonGetImage(IRibbonControl ribbonControl, bool horizontalFlip);

IPictureDisp RibbonGetImageWithHorizontalFlip(IRibbonControl ribbonControl);

IPictureDisp RibbOnGetImageWithNoHorizontalFlip(IRibbonControl ribbonControl);

bool RibbonGetVisible(IRibbonControl ribbonControl);

RibbonGetPressed(IRibbonControl ribbonControl);

Languages

About the EPM Plug-In

Migration

Extended Analytics Analyzer Report Migration