Staging BAPIs of the
SAP Business Information Warehouse
Version 2.0 GA
31.01.2000
Staging BAPIs of the
SAP Business Information
Warehouse 2.0
Specification
SAP Portals Europe GmbH
Neurottstr. 16
D-69190 Walldorf
Staging BAPIs of the
SAP Business Information Warehouse
Copyright
Copyright  2000 SAP AG. All rights reserved.
No part of this documentation may be reproduced or
transmitted in any form or for any purpose without the express
permission of SAP AG.
The information in this document is subject to change without
notice and does not represent a commitment on the part of SAP
AG in the future.
History
SAP AG
Version 2.0 GA
Status
31.01.2000
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Contents
1 Introduction ..................................................................5
Prerequisites.........................................................................................5
Certification .........................................................................................6
2 New Staging Engine Business Objects ....................... 7
InfoSourceMasterXfer .........................................................................8
Methods ................................................................................................... 8
Activate
8
InfoSourceTransXfer ............................................................................9
Methods ................................................................................................... 9
Activate
9
DataProvider ......................................................................................10
Scenario ................................................................................................. 10
Reference structures ........................................................................... 11
Methods ................................................................................................. 11
RequestInfoSourceData
11
GetParameterDefinition
12
GetHelpValues
12
InfoObject ..........................................................................................13
Key attributes ........................................................................................ 13
Attributes................................................................................................ 13
Reference structures ........................................................................... 13
Methods ................................................................................................. 13
Create
13
Change
13
ActivateMultiple
13
InfoCube ............................................................................................14
Key attributes ........................................................................................ 14
Attributes................................................................................................ 14
Reference structures ........................................................................... 14
Methods ................................................................................................. 14
Create
14
Change
14
Activate
14
GetList
15
GetDetail
15
InfoObjectCatalog............................................................................16
Key attributes ........................................................................................ 16
Attributes................................................................................................ 16
Reference structures ........................................................................... 16
Methods ................................................................................................. 16
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Create
16
Change
16
GetList
16
GetDetail
17
InfoSourceRequest ............................................................................18
Key attributes ........................................................................................ 18
Methods ................................................................................................. 18
GetStatus
18
InfoPackage ......................................................................................19
Key attributes ........................................................................................ 19
Attributes................................................................................................ 19
Reference structures ........................................................................... 19
Methods ................................................................................................. 19
Create
19
CreateFromReference
19
Change
19
GetList
20
GetDetail
20
Schedule
20
CancelSchedule
21
ABAP Dictionary Structures ..............................................................22
BAPI6107DR ........................................................................................... 22
BAPI6108IO ............................................................................................ 22
BAPI6109................................................................................................. 22
BAPI6109BTCH ....................................................................................... 23
BAPI6109DEST ........................................................................................ 23
BAPI6109FILE .......................................................................................... 23
BAPI6109HIE ........................................................................................... 24
BAPI6109IC............................................................................................. 24
BAPI6109SEL ........................................................................................... 24
BAPI6109TCP .......................................................................................... 24
BAPI6112................................................................................................. 24
BAPI6112IO ............................................................................................ 25
BAPI6112DI ............................................................................................. 25
BAPI6112DIO.......................................................................................... 26
BAPI6112L ............................................................................................... 26
BAPI6112SL ............................................................................................. 26
BAPI6113................................................................................................. 26
BAPI6113IO ............................................................................................ 26
BAPI6113L ............................................................................................... 26
BAPI6113SL ............................................................................................. 27
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
1 Introduction
This document describes the Staging BAPIs of the SAP Business Information
Warehouse, which are new in the 2.0 release of this product.
The BAPIs described in this document include new methods for updating and
retrieving meta data for InfoObjects, InfoCubes and InfoObjectCatalogs as well as
the definition of InfoPackages from a 3rd Party tool. By using these BAPIs,
customers and providers of 3rd Party tools can connect their meta data repositories
and their extraction engines to the SAP Business Information Warehouse.
Prerequisites Prerequisites for the use of the Staging BAPIs of the SAP Business Information
Warehouse are:

Knowledge of the concept of the Staging Engine of the SAP Business
Information Warehouse. Developers should be particularly au fait with the terms
InfoSource and InfoObject, transfer and communication structure, as well as the
transfer rules. Over and above that, the developers should have

Knowledge in the use of BAPIs in general and in the selected development
environment (VisualBasic, Java, …).
However, it is not necessary to have knowledge in the creation of IDocs or generally
in the use of ALE.
Currently there’s no C++ library available for the Staging BAPIs. In order to use the
BAPIs you can either call the corresponding RFC function modules defined below or
use the general BAPI OCX control.
You can generate a template for calling the function modules by executing the
following commands in the SAP Business Information Warehouse system:
1.
Select Tools  ABAP Workbench  Function Builder from the menu
2.
Enter the name of the desired function module
e.g. BAPI_ISOURCE_TD_T_GETDETAIL
3.
Select menu item Utilities -> RFC interface -> Generate
Please note, that for the function modules BAPI_ISOURCE_DP_REQUEST,
BAPI_ISOURCE_DP_GETPARDEF
and
the
new
function
module
BAPI_ISOURCE_DP_GET_HELPVALUES you will have to generate the server
sample code instead of the client sample code.
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Certification In order to get certified by SAP, a 3rd party tool has to support at least the data
extraction scenario and the read only version of the basic designer scenario. A
recertification for the new meta data BAPIs is possible.
For further information – especially about the certification process for the 2.0 BAPIs
- please contact your CSP manager.
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
2 New Staging Engine Business Objects
The following Business Objects or some of their methods are new in Release 2.0 of
the SAP Business Information Warehouse:
SAP AG

InfoSourceMasterXfer
The Business Object InfoSourceMasterXfer (BUS6104) has a new method
Activate.

InfoSourceTransXfer
The Business Object InfoSourceTransXfer (BUS6106) has a new method
Activate.

DataProvider/RemoteInfoSourceProvider
The Business Object DataProvider (BUS6107) is replaced in 2.0 by the
Business Interface RemoteInfoSourceProvider (IF6107). Furthermore it has a
new method GetHelpValues.

InfoObject
The Business Object InfoObject (BUS6108) has new methods for creating,
changing and activating.

InfoCube
The new Business Object InfoCube (BUS6112) encapsulates the properties of
an InfoCube and has methods for creating, changing and activating.

InfoObjectCatalog
The new Business Object InfoObjectCatalog (BUS6113) encapsulates the
properties of on InfoObjectCatalog and has methods for creating and changing.

InfoSourceRequest
The new Business Object InfoSourceRequest (BUS6114) encapsulates the
properties and methods of a data request from the BW to an external system.

InfoPackage
The new Business Object InfoPackage (BUS6109) encapsulates the properties
and methods of an InfoPackage and has methods for creating, changing and
scheduling.
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoSourceMasterXfer The Business Object InfoSourceMasterXfer encapsulates the attributes and methods
of an InfoSource for master data, that are specific for the InfoSources on a source
system. The new method makes it possible to activate the transfer structure for
attributes and texts.
Methods The Activate method gives the possibility to activate the transfer structure for
Activate
attributes
and
texts.
method
is
implemented
in
function
module
BAPI_ISOURCE_MD_T_ACTIVATE.
Import parameters
InfoSource
SourceSystem
LoadMethod
Export parameters
Return
SAP AG
This
InfoSource name
Source system name
Load method (‘T’ for TRFC, ‘I’ for IDoc)
Standard BAPI return parameter
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoSourceTransXfer The Business Object InfoSourceTransXfer encapsulates the attributes and methods
of an InfoSource for transaction data, that are specific for the InfoSource on a source
system. The new method makes it possible to activate the transfer structure and the
communication structure.
Methods The Activate method gives the possibility to activate the transfer structure and the
Activate
communication structure. This method is implemented in function module
BAPI_ISOURCE_TD_T_ACTIVATE.
Import parameters
InfoSource
SourceSystem
LoadMethod
Export parameters
Return
SAP AG
InfoSource name
Source system name
Load method (‘T’ for TRFC, ‘I’ for IDoc)
Standard BAPI return parameter
Ve
Staging BAPIs of the
SAP Business Information Warehouse
DataProvider
The Business Object DataProvider encapsulates a data request from SAP Business
Information Warehouse to a source system. The implementation of this Business
Object always takes place in the source system, either via a 3rd Party provider or in
one of the customer’s own developments. Therefore it is replaced in release 2.0 by
the new Business Interface RemoteInfoSourceProvider.
This Business Interface provides the same methods as the 1.2B Business Object: a
method for the transmission of data requests to the source system as well as a method
to query names and descriptions of application-defined additional parameters.
Additionally it has a new method to retrieve help values from the source system for
the selection fields in the scheduler.
Templates for the implementation of the three methods of this Business Interface are
available in the SAP Business Information Warehouse. We are dealing here with the
function
modules
BAPI_ISOURCE_DP_REQUEST
(for
the
method
RequestInfoSourceData), BAPI_ISOURCE_DP_GETPARDEF (for the method
GetParameterDefinition) and BAPI_ISOURCE_DP_GET_HELPVALUES (for the
method GetHelpValues). Simple RFC Server programs, that can be used as a basis
for the implementation of these BAPIs in the source system, can be generated based
on these function modules.
Scenario The typical scenario for this interface is the following:
Data
RemoteInfoSourceProvider.RequestInfoSourceData
InfoSourceTransXfer.GetDetail
InfoSourceTransXfer.SendData
Extraction Engine
RemoteInfoSourceProvider.GetHelpvalues
Staging BAPI
Meta data
RemoteInfoSourceProvider.GetParameterDefinition
RFC Server
Source System
Scheduler
Business Information Warehouse
Meta data
Data
When defining a data request in the SAP Business Information Warehouse the
scheduler requests a list of parameters needed to start the extraction process in the
source
system
by
calling
the
GetParameterDefinition
method
of
the
RequestInfoSourceProvider business interface. Popular examples for these
parameters are the user name and the password needed to log on to the source data
base system.
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
If the user wants to see help values from the source system for the selection fields the
scheduler calls the GetHelpValues method of the business interface and shows the
results of this call as a popup so that the user can choose one of the values as a
selection criteria.
Then the scheduler sends a data request by calling the RequestInfoSourceData
method of the RemoteInfoSourceProvider business interface. Parts of the request are
the values of the requested parameters, selection criteria and request details such as a
unique request ID, the name of the corresponding InfoSource, etc.
Reference structures The reference structures in the ABAP Dictionary for this Business Object are:






BAPI6107DR
BAPI6107DA
BAPI6107LA
BAPI6107HI
BAPI6107PA
BAPI6107PD
data request details
data selection details
text selection details
hierarchy selection details
request parameters
parameter definition
Methods The RequestInfoSourceData method sends a data request to the source system. An
RequestInfoSourceData
important attribute of this data request is the data request id that is absolutely
necessary for the processing of the data in the SAP Business Information
Warehouse.
This
method
is
implemented
in
function
module
BAPI_ISOURCE_DP_REQUEST.
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Import parameters
RequestID
InfoSource
SourceSystem
Type
Date
Time
UserName
UpdateMode
Hierarchy
Export parameters
Return
Tables
SelData
SelLanguages
Parameters
Unique ID of the data request
InfoSource name
Source system name
Type of the requested data
Request date
Request time
Name of user making request
Delta, Full, Initial
Selection based on a hierarchy request (only necessary for
hierarchy requests, structure BAPI6107HI)
Standard BAPI return parameter. For available standard error
messages please refer to the online documentation.
Selection criteria for transaction data and master data attributes
(only for requests for transaction or master data, structure
BAPI6107DA)
Selection criteria for texts for master data (Language)
(only for requests for texts, structure BAPI6107LA)
Values of the application-based parameters (only where necessary,
structure BAPI6107PA)
The GetParameterDefinition method retrieves a table of parameters needed by the
GetParameterDefinition
source system with parameter names, descriptions, data type, maximum length and
the information as to which of the parameters are mandatory. This method is
implemented in function module BAPI_ISOURCE_DP_GETPARDEF.
Export parameters
Return
Tables
ParameterDefinition
Standard BAPI return parameter. For available standard error
messages please refer to the online documentation.
Definition of the application-based parameters (structure
BAPI6107PD)
GetHelpValues The GetHelpValues method retrieves a table of help values for fields of the
InfoSource that are marked in the metadata information as selectable. These fields
are displayed in the BW scheduler under the tap strip ‘Select data’. The method is
called when the user pushes in the selection field the F4 button. This method is
implemented in function module BAPI_ISOURCE_DP_GET_HELPVALUES.
Import parameters
FieldNm
Langu
Export parameters
Return
Tables
PreviousSelList
HelpValuesList
SAP AG
Name of the selection field
Language for which the help values should be delivered
Standard BAPI return parameter. For available standard error
messages please refer to the online documentation.
List of the already selected values for other fields (structure
BAPI6107PA)
List of possible values for the selection field (structure
BAPI6107HV)
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoObject The Business Object InfoObject encapsulates the logical properties of an InfoObject.
The new methods include the creation, change and activation of InfoObjects.
Key attributes

InfoObject
Unique name of the InfoObject
Attributes

Details
InfoObject details as described by structures
BAPI6108, BAPI6108AN, BAPI6108AT,
BAPI6108CM
Reference structures The new reference structures in the ABAP Dictionary for this Business Object is:

BAPI6108IO
List of InfoObjects
Methods The Create method gives the possibility to create a new InfoObject. This method is
Create
implemented in function module BAPI_IOBJ_CREATE.
Import parameters
Details
Compounds
Attributes
NavigationAttributes
Export parameters
InfoObject
Return
Properties of the InfoObject (structure BAPI6108)
Compound InfoObjects of the InfoObject (structure BAPI6108CM)
Attributes of the InfoObject (structure BAPI6108AT)
Navigationattributes of the InfoObject (structure BAPI6108AN)
ID of the InfoObject
Standard BAPI return parameter (here as a table)
The Change method changes the actual metadata definition of an InfoObject. This
Change
method is implemented in function module BAPI_IOBJ_CHANGE.
Import parameters
InfoObject
Details
Compounds
Attributes
NavigationAttributes
Export parameters
Return
ID of the InfoObject
Properties of the InfoObject (structure BAPI6108)
Compound InfoObjects of the InfoObject (structure BAPI6108CM)
Attributes of the InfoObject (structure BAPI6108AT)
Navigationattributes of the InfoObject (structure BAPI6108AN)
Standard BAPI return parameter (here as a table)
ActivateMultiple Because one InfoObject can be dependent on one or more others it is sometimes
necessary to activate several InfoObjects simultaneously. The ActivateMultiple
method provides this functionality. This method is implemented in function module
BAPI_IOBJ_ACTIVATE_MULTIPLE.
Import parameters
InfoObjects
Export parameters
InfoObjectsError
Return
SAP AG
IDs of the InfoObject to be activated (structure BAPI6108IO)
List of InfoObjects that couldn’t be activated
Standard BAPI return parameter (here as a table)
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoCube The Business Object InfoCube encapsulates the logical properties of an InfoCube.
The central objects upon which reports and analyses in BW are based, are called
InfoCubes. An InfoCube describes (from a reporting point of view) a self-contained
dataset, for example, of a business-orientated area. From a reporting point of view, a
query always refers to an InfoCube. Technically an InfoCube is a collection of
relational tables, which is put together according to the star schema: A large fact
table in the center and several of the surrounding dimension tables. The methods of
this Business Object include the creation, change and activation of InfoCubes.
Key attributes

InfoCube
Unique name of the InfoCube
Attributes

Details
InfoCube details as described by structures BAPI6112,
BAPI6112IO, BAPI6112DI, BAPI6112DIO
Reference structures The new reference structures in ABAP Dictionary for this Business Object are:






BAPI6112
BAPI6112IO
BAPI6112DI
BAPI6112DIO
BAPI6112L
BAPI6112SL
Details of an InfoCube
InfoObjects of an InfoCube
Dimensions of an InfoCube
InfoObjects of the Dimensions of an InfoCube
List of InfoCubes
Selection criterias for InfoCubes
Methods The Create method gives the possibility to create a new InfoCube. This method is
Create
implemented in function module BAPI_CUBE_CREATE.
Import parameters
Details
InfoObjects
Dimensions
DimensionInfoObjects
Export parameters
InfoCube
Return
Properties of the InfoCube (structure BAPI6112)
InfoObjects of the InfoCube (structure BAPI6112IO)
Dimensions of the InfoCube (structure BAPI6112DI)
InfoObjects of the Dimensions (structure BAPI6112DIO)
ID of the InfoCube
Standard BAPI return parameter (here as a table)
The Change method changes the actual metadata definition of an InfoCube. This
Change
method is implemented in function module BAPI_CUBE_CHANGE.
Import parameters
InfoCube
Details
InfoObjects
Dimensions
DimensionInfoObjects
Export parameters
Return
ID of the InfoCube
Properties of the InfoCube (structure BAPI6112)
InfoObjects of the InfoCube (structure BAPI6112IO)
Dimensions of the InfoCube (structure BAPI6112DI)
InfoObjects of the Dimensions (structure BAPI6112DIO)
Standard BAPI return parameter (here as a table)
The Activate method activates an InfoCube. Only consistent InfoCubes can be
Activate
activated. This is checked and if errors occur these are returned in the parameter
RETURN (as a table of messages). This method is implemented in function module
BAPI_CUBE_ACTIVATE.
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Import parameters
InfoCube
Export parameters
Return
ID of the InfoCube
Standard BAPI return parameter (here as a table)
GetList The GetList method delivers InfoCubes according to the selection criteria (with
describing
texts).
This
method
is
implemented
in
function
module
BAPI_CUBE_GETLIST. The list of the InfoCubes is sorted by InfoCube names.
Import parameters
Objvers
Cubetype
SelInfoCube
SelTextLong
Export parameters
Return
InfoCubeList
Version of the InfoCubes to be selected (A, M, D, %)
Type of the InfoCubes to be selected (B, R, %)
Selection criteria for the name of the InfoCube (structure
BAPI6112SL)
Selection criteria for the long text description of the InfoCube
(structure BAPI6100SL)
Standard BAPI return parameter
Table of the InfoCubes (according to selection conditions) with
long text descriptions (structure BAPI6112L)
The GetDetail method delivers detailed information on the InfoCube. This method is
GetDetail
implemented in function module BAPI_CUBE_GETDETAIL.
Import parameters
InfoCube
Objvers
Export parameters
Details
InfoObjects
Dimensions
DimensionInfoObjects
Return
SAP AG
ID of the InfoCube
Version of the InfoCube (A, M, D)
Properties of the InfoCube (structure BAPI6112)
InfoObjects of the InfoCube (structure BAPI6112IO)
Dimensions of the InfoCube (structure BAPI6112DI)
InfoObjects of the Dimensions (structure BAPI6112DIO)
Standard BAPI return parameter
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoObjectCatalog The Business Object InfoObjectCatalog encapsulates the logical properties of an
InfoObjectCatalog. An InfoObjectCatalog is a grouping of InfoObjects according to
application-specific viewpoints. This enables easier handling of what can be a very
large number of InfoObjects in a given context. The methods of this Business Object
include the creation and change of an InfoObjectCatalog.
Key attributes

InfoObjCat
Unique name of the InfoObjectCatalog
Attributes

Details
InfoObjectCatalog details as described by the structure
BAPI6113
Reference structures The new reference structures in ABAP Dictionary for this Business Object are:




BAPI6113
BAPI6113IO
BAPI6113L
BAPI6113SL
Details of an InfoObjectCatalog
InfoObjects of an InfoObjectCatalog
List of InfoObjectCatalogs
Selection criterias for InfoObjectCatalogs
Methods The Create method gives the possibility to create a new InfoObjectCatalog. This
method is implemented in function module BAPI_IOBC_CREATE.
Create
Import parameters
Details
InfoObjects
Export parameters
InfoObjCat
Return
Properties of the InfoObjectCatalog (structure BAPI6113)
InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
ID of the InfoObjectCatalog
Standard BAPI return parameter (here as a table)
The Change method changes the actual definition of an InfoObjectCatalog. This
Change
method is implemented in function module BAPI_IOBC_CHANGE.
Import parameters
InfoObjCat
Details
InfoObjects
Export parameters
Return
ID of the InfoObjectCatalog
Properties of the InfoObjectCatalog (structure BAPI6113)
InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
Standard BAPI return parameter (here as a table)
The GetList method delivers InfoObjectCatalogs according to the selection criteria
GetList
SAP AG
(with describing texts). This method is implemented in function module
BAPI_IOBC_GETLIST.
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Import parameters
Objvers
IobjTp
SelInfoObjCat
SelTextLong
Export parameters
Return
InfoObjCatList
Version of the InfoObjectCatalogs to be selected (A, D, %)
Type of the InfoObjectCatalogs to be selected (CHA, KYF, %)
Selection criteria for the name of the InfoObjectCatalog (structure
BAPI6113SL)
Selection criteria for the long text description of the
InfoObjectCatalog (structure BAPI6100SL)
Standard BAPI return parameter
Table of the InfoObjectCatalogs (according to selection
conditions) with long text descriptions (structure BAPI6113L)
The GetDetail method delivers detailed information on the InfoObjectCatalog. This
GetDetail
method is implemented in function module BAPI_IOBC_GETDETAIL.
Import parameters
InfoObjCat
Objvers
Export parameters
Details
InfoObjects
Return
SAP AG
ID of the InfoObjectCatalog
Version of the InfoObjectCatalog (A, D)
Properties of the InfoObjectCatalog (structure BAPI6113)
InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
Standard BAPI return parameter
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoSourceRequest The Business Object InfoSourceRequest represents a data request for a specific BW
InfoSource. An instance is implicitly created when scheduling an InfoPackage. The
only method of this Business Object is at the moment GetStatus.
Key attributes

RequestID
Unique ID of the request
Methods The GetStatus method determines the actual status of an InfoSourceRequest. This
GetStatus
method is implemented in function module BAPI_ISREQUEST_GETSTATUS.
Import parameters
RequestID
Export parameters
TechStatus
TechInfo
QualStatus
QualInfo
Return
SAP AG
ID of the request
Technical status of the request (G, Y, R)
Information to the technical status (plain text)
Manual set status of the request (G, Y, R, initial)
Information to the manual set status (plain text)
Standard BAPI return parameter (here as a table)
Ve
Staging BAPIs of the
SAP Business Information Warehouse
InfoPackage The Business Object InfoPackage encapsulates the logical properties of an
InfoPackage. An InfoPackage is the entry point for the loading process of a specific
InfoSource to a specific source system. The methods of this Business Object include
the creation and change of an InfoPackage and the start of a load process.
Key attributes

InfoPackage
Unique name of the InfoPackage
Attributes

Details
InfoPackage details as described by the structure
BAPI6109
Reference structures The new reference structures in ABAP Dictionary for this Business Object are:










BAPI6109
BAPI6109BTCH
BAPI6109DEST
BAPI6109DSSL
BAPI6109FILE
BAPI6109HIE
BAPI6109IC
BAPI6109L
BAPI6109SEL
BAPI6109TCP
Details of an InfoPackage
Scheduling parameters
Destination of the data
Selection criterias for DataSource
Parameters for loading from flat file
Parameters for loading of hierarchies
InfoCubes to be updated
List of InfoPackages
Selection parameters
Third Party parameters
Methods The Create method gives the possibility to create a new InfoPackage. This method is
implemented in function module BAPI_IPAK_CREATE.
Create
Import parameters
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Export parameters
InfoPackage
Return
Properties of the InfoPackage (structure BAPI6109)
Scheduling parameters (structure BAPI6109BTCH)
Destination of the data (structure BAPI6109DEST)
Parameters for loading from flat file (structure BAPI6109FILE)
Parameters for loading hierarchies (structure BAPI6109HIE)
Selection parameters (structure BAPI6109SEL)
InfoCubes to be updated (structure BAPI6109IC)
Third Party parameters (structure BAPI6109TCP)
ID of the InfoPackage
Standard BAPI return parameter
The CreateFromReference method gives the possibility to create a new InfoPackage
CreateFromReference
on basis of an already existing one. This method is implemented in function module
BAPI_IPAK_CREATE_FROM_REF.
Import parameters
InfoPackageRef
Text
Export parameters
InfoPackage
Return
ID of the referenced InfoPackage
Description of the InfoPackage
ID of the created InfoPackage
Standard BAPI return parameter
Change
SAP AG
Ve
Staging BAPIs of the
SAP Business Information Warehouse
The Change method changes the actual definition of an InfoPackage. This method is
implemented in function module BAPI_IPAK_CHANGE.
Import parameters
InfoPackage
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Export parameters
Return
ID of the InfoPackage
Properties of the InfoPackage (structure BAPI6109)
Scheduling parameters (structure BAPI6109BTCH)
Destination of the data (structure BAPI6109DEST)
Parameters for loading from flat file (structure BAPI6109FILE)
Parameters for loading hierarchies (structure BAPI6109HIE)
Selection parameters (structure BAPI6109SEL)
InfoCubes to be updated (structure BAPI6109IC)
Third Party parameters (structure BAPI6109TCP)
Standard BAPI return parameter
GetList The GetList method delivers a list of InfoPackages according to the selection criteria
(with describing texts). This method is implemented in function module
BAPI_IPAK_GETLIST.
Import parameters
JobStatus
SelInfoSource
SelDataSource
SelSourceSystem
SelTextLong
Export parameters
Return
InfoPackageList
Status of the scheduled job
Selection criteria for the InfoSources (structure BAPI6102SL)
Selection criteria for the DataSources (structure BAPI6109DSSL)
Selection criteria for the SourceSystems (structure BAPI6101SL)
Selection criteria for the long text description of the InfoPackages
(structure BAPI6100SL)
Standard BAPI return parameter
Table of the InfoPackages (according to selection conditions) with
long text descriptions (structure BAPI6109L)
The GetDetail method delivers detailed information for an InfoPackage. This
GetDetail
method is implemented in function module BAPI_IPAK_GETDETAIL.
Import parameters
InfoPackage
Export parameters
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Return
ID of the InfoPackage
Properties of the InfoPackage (structure BAPI6109)
Scheduling parameters (structure BAPI6109BTCH)
Destination of the data (structure BAPI6109DEST)
Parameters for loading from flat file (structure BAPI6109FILE)
Parameters for loading hierarchies (structure BAPI6109HIE)
Selection parameters (structure BAPI6109SEL)
InfoCubes to be updated (structure BAPI6109IC)
Third Party parameters (structure BAPI6109TCP)
Standard BAPI return parameter
The Schedule method gives the possibility to schedule an InfoPackage with the
Schedule
SAP AG
previously defined parameters. This method is implemented in function module
BAPI_IPAK_START.
Ve
Staging BAPIs of the
SAP Business Information Warehouse
Import parameters
InfoPackage
Export parameters
RequestID
Return
ID of the InfoPackage
ID of the generated request
Standard BAPI return parameter (here as a table)
The CancelSchedule method gives the possibility to abort an already scheduled
CancelSchedule
loading process that is not yet started. This method is implemented in function
module BAPI_IPAK_STOP.
Import parameters
InfoPackage
Export parameters
Return
SAP AG
ID of the InfoPackage
Standard BAPI return parameter
Ve
Staging BAPIs of the
SAP Business Information Warehouse
ABAP Dictionary Structures This section contains a technical description of the ABAP Dictionary structures and
their components used for the new business objects and their methods. For more
details on single data fields, especially with respect to possible values, we refer to the
ABAP dictionary on your SAP Business Information Warehouse system.
BAPI6107DR The dictionary structure BAPI6107DR is used for data request details.
Field name
REQUEST
INFOSOURCE
SOURCESYSTEM
REQUESTTYPE
REQUESTDATE
REQUESTTIME
REQUESTUSER
UPDATEMODE
REQUESTSTATUS
REQUESTINFO
Type
CHAR
CHAR
CHAR
CHAR
DATS
TIMS
CHAR
CHAR
CHAR
CHAR
Length
30
30
10
1
8
6
12
2
1
120
Description
Request number
Name of the InfoSource
Name of the source system
Type of requested data
Request date
Request time
User name of the requesting user
Requested update mode
Status of the request
Plain text to the request status
BAPI6108IO The dictionary structure BAPI6108IO represents a list of InfoObjects.
Field name
INFOOBJECT
Type
CHAR
Length
30
Description
Name of the InfoObject
The dictionary structure BAPI6109 represents the details of an InfoPackage.
BAPI6109
Field name
INFOPACKAGE
INFOSOURCE
INFOSOURCETYPE
Type
CHAR
CHAR
CHAR
Length
30
30
1
LOGSYS
DATASOURCE
DATASOURCETYPE
CHAR
CHAR
CHAR
10
30
1
HIERACT
CHAVL_CHECK
UPDATEMASTERDATA
CHAR
CHAR
CHAR
1
1
1
TEXT
LOAD_STATUS
CHAR
CHAR
60
1
UPMODE_READ
SAP AG
Description
ID of the InfoPackage
Name of the InfoSource
Type of the InfoSource 'I' for Transaction
Data, 'O' for others
Name of the Source System
Name of the DataSource
Type of the DataSource; 'D' for
Transaction Data, 'M' for Master Data, 'T'
for Texts and 'H' for Hierarchies
Read only Mode of data upload
'F' for Full upload, 'D' for Delta upload, 'R'
for Repeat upload, 'C' for Initialisation of
the Delta upload.
Automatic activation of hierarchy
Check for consistency
'3' means Update only when all
Masterdata exists, '1' means update always
which means auto-Sid-generation
Description of the InfoPackage
Scheduling status; 'R' for running, 'S' for
scheduled, 'F' for finished, 'A' for abend,
'P' for planned, all others are only shorttime status which should switch to one of
the mentioned status. If not you have a
problem with the R/3 Basis, Database or
the configuration of you batch-processing
or no authority to plan/schedule/start a
batch job.
Ve
Staging BAPIs of the
SAP Business Information Warehouse
BAPI6109BTCH The dictionary structure BAPI6109BTCH represents the scheduling parameters of an
InfoPackage.
Field name
STARTDTTYP
SDLSTRTDT
SDLSTRTTM
EVENTID
EVENTPARM
PERIODIC
CANCELPERIOD
Type
CHAR
DATS
TIMS
CHAR
CHAR
CHAR
CHAR
Length
1
8
6
32
64
1
10
EVENT_ID_OK
CHAR
32
EVENT_PM_OK
CHAR
64
EVENT_ID_ER
CHAR
32
EVENT_PM_ER
CHAR
64
FUNCTION_CALL
CHAR
1
EXIT_CALL
CHAR
1
Description
Type of start date
Scheduled execution date
Scheduled execution time
Event-ID to start the package
Event-Parameter to start the package
'X' for periodic job
Cancel the periodic job after 'XXX' runs
'0' or initial means no cancelation
Event which will be raised by the package
after the load was OK (green light)
Parameter of the Event after the load was
OK (green light)
Event which will be raised by the package
after the load was not OK (red light)
Parameter of the Event after the load was
not OK (red light)
'X' means start the function module
'RSSM_START_SECOND_PROCESS'
after the load is finished (red or green)
'X' means start the Business-Add-In after
the load is finished (red or green)
BAPI6109DEST In the dictionary structure BAPI6109DEST it is possible to specify the destination of
the data.
Field name
ONLYENTRANCE
ONLYCUBETAB
PARALLEL
Type
CHAR
CHAR
CHAR
Length
1
1
1
CUBEAFTERODS
CHAR
1
Description
Only to PSA or ALE entrance
Only to InfoCube or table
Processing in parallel (datapackage will be
processed in 2 parallel processes; One
process writes to the PSA, the other to the
cube for each datapackage of the request).
To Cubes after PSA is completed and
green (for all datapackages of the request)
BAPI6109FILE In the dictionary structure BAPI6109FILE it is possible to specify the parameters for
a load from a flat file.
SAP AG
Field name
LOCATION
Type
CHAR
Length
1
FILENAME
FILETYPE
CHAR
CHAR
128
1
FILESEP
ESC
CHAR1000
DECICHAR
CURRCONV
RAW
RAW
CHAR
CHAR
CHAR
1
1
1
1
1
Description
Location of the file (client workstation or
application server
'0' means data from the appl.server
'1' means data from the client workstation
Name of the file
Type of the file (ASCII, CSV)
'1' means Ascii-File
'2' means Excel-CSV-Typ
Separator for CSV files
Escape sign
Thousand separator
Character for decimal point
Currency conversion from external to
Ve
Staging BAPIs of the
SAP Business Information Warehouse
internal format
BAPI6109HIE In the dictionary structure BAPI6109HIE it is possible to specify the hierarchy to be
loaded.
Field name
HIENM
HIEVERS
HIEDATETO
HIEDATEFROM
HIECLASS
NEW_HIENAME_ON
NEW_HIENM
Type
CHAR
CHAR
DATS
DATS
CHAR
CHAR
CHAR
Length
30
3
8
8
4
1
30
Description
Name of the hierarchy
Version of the hierarchy
Valid until
Valid from
Hierarchy class
New hierarchy name wanted?
New name of the hierarchy
BAPI6109IC In the dictionary structure BAPI6109IC it is possible to specify the InfoCubes that
should be updated during the load process.
Field name
INFOCUBE
LOADCUBE
DELETEALLBEFORE
Type
CHAR
CHAR
CHAR
Length
30
1
1
Description
Name of the InfoCube
InfoCube should be updated
Delete the whole cube content before
loading data to the cube
BAPI6109SEL In the dictionary structure BAPI6109SEL it is possible to specify selection
parameters for the load process.
Field name
FIELDNAME
IOBJNM
SIGN
Type
CHAR
CHAR
CHAR
Length
30
30
1
OPT
CHAR
2
LOW
HIGH
CHAR
CHAR
45
45
Description
Field name
InfoObject name
Selection operator (see ranges tables)
(only 'I' useful)
Selection operator (see ranges tables)
(only 'EQ' or 'BT' useful)
Lower bound
Upper bound
The dictionary structure BAPI6109TCP represents the parameters needed for the
BAPI6109TCP
access to the 3rd party system.
Field name
RFCFIELDNM
RFCVALUE
RFCUSER
PASSWORD
Type
CHAR
CHAR
CHAR
CHAR
Length
30
128
32
8
Description
Name of the field to be filled
Value of the field
User to logon to the 3rd party system
Password to logon to the 3rd party system
BAPI6112 The dictionary structure BAPI6112 represents the details of an InfoCube.
Field name
INFOCUBE
OBJVERS
TEXTLONG
OBJSTAT
CONTREL
SAP AG
Type
CHAR
CHAR
CHAR
CHAR
CHAR
Length
30
1
60
3
6
Description
InfoCube
Objectversion
Long text
Objectstatus
Content release
Ve
Staging BAPIs of the
SAP Business Information Warehouse
CONTTIMESTMP
OWNER
ACTIVFL
BWAPPL
INFOAREA
NCUMTIM
CUBETYPE
BASICCUBE
SLOGSYS
PARTTIM
PARTVL_FROM
PARTVL_TO
PARTMAXCNT
DIMESIZCAT
DIMEDATCLS
CUBESIZCAT
DEC
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
INT4
CHAR
CHAR
CHAR
15
12
1
10
30
30
1
30
10
30
10
10
10
2
5
2
CUBEDATCLS
BWSTATISTICS
BWSTATWHM
AUTOQUALOKFL
CHAR
CHAR
CHAR
CHAR
5
1
1
1
AUTOROLLUPFL
CHAR
1
AUTOCOMPRFL
CHAR
1
CLEAR_INDEX
DELTA_INDEX
REBUILD_STAT
DELTA_STAT
PERCENTAGE
NULLCOMP
CHAR
CHAR
CHAR
CHAR
NUMC
CHAR
1
1
1
1
3
1
REFUPDATE
READMODE
TSTPNM
TIMESTMP
CHAR
CHAR
CHAR
DEC
1
1
12
15
Content timestamp
Owner
Active and modified version identical
BW application (namespace)
InfoArea
Ref. time char. for non cumulatives
InfoCube type
Basic InfoCube for the aggregate
Source system
Partitioning time characteristic
Lower limit (partitioning value)
Upper limit (partitioning value)
Maximum number of partitions
BW: Size category for dimension tables
BW: Data class for dimension tables
BW: Size category for InfoCube (fact)
tables
BW: Data class for InfoCube (fact)tables
Flag for BW statistics
Flag for BW WHM statistics
Flag: Technical ok implies ok quality of
the request
Flag: Automatically roll up after the
quality ok
Flag: Automatically compress after the
roll-up
Internal use
Internal use
Internal use
Internal use
Internal use
Zero elimination in the summarization
module
Read mode (read everything)
Last changed by
UTC time stamp in short form
(YYYYMMDDhhmmss)
BAPI6112IO The dictionary structure BAPI6112IO represents the list of InfoObjects of an
InfoCube.
Field name
INFOCUBE
OBJVERS
POSIT
INFOOBJECT
IOBJTP
ATRNAVFL
Type
CHAR
CHAR
NUMC
CHAR
CHAR
CHAR
Length
30
1
4
30
3
1
Description
InfoCube
Object version
Position of the field in the structure / table
Name of the InfoObject
Type of an InfoObject
The InfoObject is a navigation attribute
BAPI6112DI The dictionary structure BAPI6112DI represents the dimensions of an InfoCube.
Field name
INFOCUBE
OBJVERS
DIMENSION
TEXTLONG
IOBJTP
LINITFL
SAP AG
Type
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
Length
30
1
30
60
3
1
Description
InfoCube
Object version
Dimensionname
Long description
Type of an InfoObject
Flag: Line item dimension
Ve
Staging BAPIs of the
SAP Business Information Warehouse
BAPI6112DIO The dictionary structure BAPI6112DIO represents the InfoObjects of a dimension of
an InfoCube.
Field name
INFOCUBE
OBJVERS
DIMENSION
POSIT
INFOOBJECT
ATRNAVFL
Type
CHAR
CHAR
CHAR
NUMC
CHAR
CHAR
Length
30
1
30
4
30
1
Description
InfoCube
Object version
Dimensionname
Position of the field in the structure / table
Name of the InfoObject
The InfoObject is a navigation attribute
BAPI6112L The dictionary structure BAPI6112L is used to provide a list of InfoCubes.
Field name
INFOCUBE
OBJVERS
TEXTLONG
OBJSTAT
ACTIVFL
INFOAREA
CUBETYPE
Type
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
Length
30
1
60
3
1
30
1
Description
InfoCube
Object version
Long description
Objectstatus
Active and modified version identical
InfoArea
InfoCube type
BAPI6112SL The dictionary structure BAPI6112SL is used for the specification of selection
criteria for InfoCubes.
Field name
SIGN
OPTION
INFOCUBELOW
INFOCUBEHIGH
Type
CHAR
CHAR
CHAR
CHAR
Length
1
2
30
30
Description
Selection operator (see ranges tables)
Selection operator (see ranges tables)
InfoCube (lower bound)
InfoCube (upper bound)
BAPI6113 The dictionary structure BAPI6113 represents the details of an InfoObjectCatalog.
Field name
INFOOBJCAT
OBJVERS
TEXTLONG
OBJSTAT
CONTREL
CONTTIMESTMP
OWNER
BWAPPL
IOBJTP
INFOAREA
TSTPNM
TIMESTMP
Type
CHAR
CHAR
CHAR
CHAR
CHAR
DEC
CHAR
CHAR
CHAR
CHAR
CHAR
DEC
Length
30
1
60
3
6
15
12
10
3
30
12
15
Description
InfoObjectCatalog
Objectversion
Long description
Objectstatus
Content release
Content timestamp
Owner
BW application (namespace)
Type of an InfoObject
InfoArea
Last changed by
UTC time stamp in short form
(YYYYMMDDhhmmss)
BAPI6113IO The dictionary structure BAPI6113IO represents the list of InfoObjects of an
InfoObjectCatalog.
Field name
INFOOBJCAT
OBJVERS
INFOOBJECT
Type
CHAR
CHAR
CHAR
Length
30
1
30
Description
InfoObjectCatalog
Object version
Name of the InfoObject
BAPI6113L The dictionary structure BAPI6113L is used to provide a list of InfoObjectCatalogs.
Field name
INFOCUBE
OBJVERS
TEXTLONG
SAP AG
Type
CHAR
CHAR
CHAR
Length
30
1
60
Description
InfoCube
Object version
Long description
Ve
Staging BAPIs of the
SAP Business Information Warehouse
OBJSTAT
IOBJTP
INFOAREA
CHAR
CHAR
CHAR
3
3
30
Object status
Type of an InfoObject
InfoArea
BAPI6113SL The dictionary structure BAPI6113SL is used for the specification of selection
criteria for InfoObjectCatalogs.
Field name
SIGN
OPTION
INFOOBJCATLOW
INFOOBJCATHIGH
SAP AG
Type
CHAR
CHAR
CHAR
CHAR
Length
1
2
30
30
Description
Selection operator (see ranges tables)
Selection operator (see ranges tables)
InfoObjectCatalog (lower bound)
InfoObjectCatalog (upper bound)
Ve