Stagingbapi 20 PDF

BAPIs of the
SAP Business Information Warehouse

6WDJLQJ
9HUVLRQ*$

6WDJLQJ%$3,VRIWKH
6$3%XVLQHVV,QIRUPDWLRQ
:DUHKRXVH
6SHFLILFDWLRQ

!"!#%$'&)(*(,+ -
6WDJLQJ BAPIs of the

&RS\ULJKW
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.
2ULJLQDOGRFXPHQW
$XWKRUV
+LVWRU\
6$3$*
The original of this document is stored under the file

StagingBAPI_20.DOC.
Uwe Enders
Version 2.0 GA
Status
31.01.2000

&RQWHQWV
,QWURGXFWLRQ
3UHUHTXLVLWHV
&HUWLILFDWLRQ
1HZ6WDJLQJ(QJLQH%XVLQHVV2EMHFWV
,QIR6RXUFH0DVWHU;IHU
0HWKRGV
$FWLYDWH

,QIR6RXUFH7UDQV;IHU
0HWKRGV
$FWLYDWH

'DWD3URYLGHU

6FHQDULR
5HIHUHQFHVWUXFWXUHV
0HWKRGV
5HTXHVW,QIR6RXUFH'DWD

*HW3DUDPHWHU'HILQLWLRQ

*HW+HOS9DOXHV

,QIR2EMHFW

.H\DWWULEXWHV
$WWULEXWHV
5HIHUHQFHVWUXFWXUHV
0HWKRGV
&UHDWH

&KDQJH

$FWLYDWH0XOWLSOH

,QIR&XEH
.H\DWWULEXWHV
$WWULEXWHV
5HIHUHQFHVWUXFWXUHV
0HWKRGV
&UHDWH

&KDQJH

$FWLYDWH

*HW/LVW

*HW'HWDLO

,QIR2EMHFW&DWDORJ

.H\DWWULEXWHV
$WWULEXWHV
5HIHUHQFHVWUXFWXUHV
0HWKRGV
6$3$*

&UHDWH

&KDQJH

*HW/LVW

*HW'HWDLO

,QIR6RXUFH5HTXHVW

.H\DWWULEXWHV
0HWKRGV
*HW6WDWXV

,QIR3DFNDJH

.H\DWWULEXWHV
$WWULEXWHV
5HIHUHQFHVWUXFWXUHV
0HWKRGV
&UHDWH

&UHDWH)URP5HIHUHQFH

&KDQJH

*HW/LVW

*HW'HWDLO

6FKHGXOH

&DQFHO6FKHGXOH

$%$3'LFWLRQDU\6WUXFWXUHV
%$3,'5
%$3,,2
%$3,
%$3,%7&+
%$3,'(67
%$3,),/(
%$3,+,(
%$3,,&
%$3,6(/
%$3,7&3
%$3,
%$3,,2
%$3,',
%$3,',2
%$3,/
%$3,6/
%$3,
%$3,,2
%$3,/
%$3,6/
6$3$*

,QWURGXFWLRQ
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.
3UHUHTXLVLWHV
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 DXIDLW 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 theres 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.
6$3$*

&HUWLILFDWLRQ
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.
6$3$*

1HZ6WDJLQJ(QJLQH%XVLQHVV2EMHFWV
The following Business Objects or some of their methods are new in Release 2.0 of
the SAP Business Information Warehouse:
The Business Object ,QIR6RXUFH0DVWHU;IHU(BUS6104) has a new method

$FWLYDWH
,QIR6RXUFH7UDQV;IHU
The Business Object ,QIR6RXUFH7UDQV;IHU(BUS6106) has a new method

$FWLYDWH
'DWD3URYLGHU5HPRWH,QIR6RXUFH3URYLGHU
The Business Object 'DWD3URYLGHU(BUS6107) is replaced in 2.0 by the

Business Interface 5HPRWH,QIR6RXUFH3URYLGHU(IF6107). Furthermore it has a
new method *HW+HOS9DOXHV
,QIR2EMHFW
The Business Object ,QIR2EMHFW(BUS6108) has new methods for creating,

changing and activating.
,QIR&XEH
The new Business Object ,QIR&XEH(BUS6112) encapsulates the properties of

an InfoCube and has methods for creating, changing and activating.
,QIR2EMHFW&DWDORJ
The new Business Object ,QIR2EMHFW&DWDORJ(BUS6113) encapsulates the

properties of on InfoObjectCatalog and has methods for creating and changing.
,QIR6RXUFH5HTXHVW
The new Business Object ,QIR6RXUFH5HTXHVW(BUS6114) encapsulates the

properties and methods of a data request from the BW to an external system.
,QIR3DFNDJH
The new Business Object ,QIR3DFNDJH(BUS6109) encapsulates the properties

and methods of an InfoPackage and has methods for creating, changing and
scheduling.
6$3$*

The Business Object
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.
0HWKRGV
$FWLYDWH
The
$FWLYDWH
attributes
method gives the possibility to activate the transfer structure for
and
texts.
This
is
implemented
in
function
module
%$3,B,6285&(B0'B7B$&7,9$7(
Import parameters
InfoSource
SourceSystem
LoadMethod
Export parameters
Return
6$3$*
method
InfoSource name
Source system name
Load method (T for TRFC, I for IDoc)
Standard BAPI return parameter

,QIR6RXUFH7UDQV;IHU
The Business Object
,QIR6RXUFH7UDQV;IHU
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.
0HWKRGV
$FWLYDWH
The
$FWLYDWH
method gives the possibility to activate the transfer structure and the
communication structure. This method is implemented in function module

%$3,B,6285&(B7'B7B$&7,9$7(
Import parameters
InfoSource
SourceSystem
LoadMethod
Export parameters
Return
6$3$*
InfoSource name
Source system name
Load method (T for TRFC, I for IDoc)

'DWD3URYLGHU
The Business Object
'DWD3URYLGHU
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 customers own developments. Therefore it is replaced in release 2.0 by
the new Business Interface 5HPRWH,QIR6RXUFH3URYLGHU
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
%$3,B,6285&(B'3B5(48(67
modules
),
method
(for
%$3,B,6285&(B'3B*(73$5'()
the
(for the method
%$3,B,6285&(B'3B*(7B+(/39$/8(6
) and
method
(for the
*HW+HOS9DOXHV
). 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.
6FHQDULR
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
5HTXHVW,QIR6RXUFH3URYLGHU
the
method
of
the
business interface. Popular examples for these
parameters are the user name and the password needed to log on to the source data
base system.
6$3$*

If the user wants to see help values from the source system for the selection fields the
scheduler calls the
*HW+HOS9DOXHV
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
method of the 5HPRWH,QIR6RXUFH3URYLGHU 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.
5HIHUHQFHVWUXFWXUHV
The reference structures in the ABAP Dictionary for this Business Object are:
0HWKRGV
The
BAPI6107DR
BAPI6107DA
BAPI6107LA
BAPI6107HI
BAPI6107PA
BAPI6107PD
data request details

data selection details
text selection details
hierarchy selection details
request parameters
parameter definition
method sends a data request to the source system. An
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
%$3,B,6285&(B'3B5(48(67
6$3$*

Import parameters
RequestID
InfoSource
SourceSystem
Type
Date
Time
UserName
UpdateMode
Hierarchy
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)
Export parameters
Return
Standard BAPI return parameter. For available standard error

messages please refer to the online documentation.
Tables
SelData
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)
SelLanguages
Parameters
The
method retrieves a table of parameters needed by the
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 %$3,B,6285&(B'3B*(73$5'()
Export parameters
Return

Tables
ParameterDefinition
*HW+HOS9DOXHV
The
*HW+HOS9DOXHV
Definition of the application-based parameters (structure

BAPI6107PD)
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 %$3,B,6285&(B'3B*(7B+(/39$/8(6
Import parameters
FieldNm
Langu
Export parameters
Return
Name of the selection field

Language for which the help values should be delivered
Tables
PreviousSelList
List of the already selected values for other fields (structure

BAPI6107PA)
List of possible values for the selection field (structure
BAPI6107HV)
HelpValuesList
6$3$*

,QIR2EMHFW
The Business Object ,QIR2EMHFWencapsulates the logical properties of an InfoObject.

The new methods include the creation, change and activation of InfoObjects.
.H\DWWULEXWHV
InfoObject
Unique name of the InfoObject
$WWULEXWHV
Details
InfoObject details as described by structures

BAPI6108, BAPI6108AN, BAPI6108AT,
BAPI6108CM
5HIHUHQFHVWUXFWXUHV
The new reference structures in the ABAP Dictionary for this Business Object is:
0HWKRGV
&UHDWH
The
BAPI6108IO
&UHDWH
List of InfoObjects
method gives the possibility to create a new InfoObject. This method is
implemented in function module %$3,B,2%-B&5($7(

Import parameters
Details
Compounds
Attributes
NavigationAttributes
Export parameters
InfoObject
Return
&KDQJH
The
&KDQJH
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)
method changes the actual metadata definition of an InfoObject. This
method is implemented in function module %$3,B,2%-B&+$1*(

Import parameters
InfoObject
Details
Compounds
Attributes
NavigationAttributes
Export parameters
Return
$FWLYDWH0XOWLSOH
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)
Because one InfoObject can be dependent on one or more others it is sometimes

necessary to activate several InfoObjects simultaneously. The
$FWLYDWH0XOWLSOH
method provides this functionality. This method is implemented in function module

%$3,B,2%-B$&7,9$7(B08/7,3/(
Import parameters
InfoObjects
Export parameters
InfoObjectsError
Return
6$3$*
IDs of the InfoObject to be activated (structure BAPI6108IO)

List of InfoObjects that couldnt be activated

,QIR&XEH
The Business Object ,QIR&XEH 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.
.H\DWWULEXWHV
InfoCube
Unique name of the InfoCube
$WWULEXWHV
Details
InfoCube details as described by structures BAPI6112,

BAPI6112IO, BAPI6112DI, BAPI6112DIO
5HIHUHQFHVWUXFWXUHV
The new reference structures in ABAP Dictionary for this Business Object are:
0HWKRGV
&UHDWH
The
BAPI6112
BAPI6112IO
BAPI6112DI
BAPI6112DIO
BAPI6112L
BAPI6112SL
&UHDWH
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
method gives the possibility to create a new InfoCube. This method is
implemented in function module %$3,B&8%(B&5($7(

Import parameters
Details
InfoObjects
Dimensions
DimensionInfoObjects
Export parameters
InfoCube
Return
&KDQJH
The
&KDQJH
$FWLYDWH
ID of the InfoCube
method changes the actual metadata definition of an InfoCube. This
method is implemented in function module %$3,B&8%(B&+$1*(

Import parameters
InfoCube
Details
InfoObjects
Dimensions
Export parameters
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)
The
$FWLYDWH
ID of the InfoCube
method activates an InfoCube. Only consistent InfoCubes can be
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
%$3,B&8%(B$&7,9$7(
6$3$*

Import parameters
InfoCube
Export parameters
Return
*HW/LVW
The
*HW/LVW
describing
ID of the InfoCube
method delivers InfoCubes according to the selection criteria (with

texts).
This
%$3,B&8%(B*(7/,67
Import parameters
Objvers
Cubetype
SelInfoCube
Export parameters
Return
InfoCubeList
*HW'HWDLO
implemented
in
function
module

Table of the InfoCubes (according to selection conditions) with

long text descriptions (structure
)
The *HW'HWDLO method delivers detailed information on the InfoCube. This method is
implemented in function module %$3,B&8%(B*(7'(7$,/.
Import parameters
InfoCube
Objvers
Export parameters
Details
InfoObjects
Dimensions
Return
6$3$*
is
Version of the InfoCubes to be selected (A, M, D, %)

Type of the InfoCubes to be selected (B, R, %)
for the name of the InfoCube (structure
Selection

criteria

)
Selection criteria for the long text description of the InfoCube

(structure
)
SelTextLong
method
The list of the InfoCubes is sorted by InfoCube names.
ID of the InfoCube
Version of the InfoCube (A, M, D)

,QIR2EMHFW&DWDORJ
The Business Object ,QIR2EMHFW&DWDORJ 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.
.H\DWWULEXWHV
InfoObjCat
Unique name of the InfoObjectCatalog
$WWULEXWHV
Details
InfoObjectCatalog details as described by the structure

BAPI6113
5HIHUHQFHVWUXFWXUHV
0HWKRGV
The
&KDQJH
&UHDWH
Details of an InfoObjectCatalog
InfoObjects of an InfoObjectCatalog
List of InfoObjectCatalogs
Selection criterias for InfoObjectCatalogs
method gives the possibility to create a new InfoObjectCatalog. This
method is implemented in function module %$3,B,2%&B&5($7(

Import parameters
Details
InfoObjects
Export parameters
InfoObjCat
Return
&UHDWH
BAPI6113
BAPI6113IO
BAPI6113L
BAPI6113SL
The
&KDQJH
Properties of the InfoObjectCatalog (structure BAPI6113)

InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
ID of the InfoObjectCatalog
method changes the actual definition of an InfoObjectCatalog. This
method is implemented in function module %$3,B,2%&B&+$1*(

Import parameters
InfoObjCat
Details
InfoObjects
Export parameters
Return
*HW/LVW
6$3$*
The
*HW/LVW
method delivers InfoObjectCatalogs according to the selection criteria
(with describing texts). This method is implemented in function module

%$3,B,2%&B*(7/,67

Import parameters
Objvers
IobjTp
SelInfoObjCat

SelTextLong
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
)
Selection criteria for the long text description of the
)
InfoObjectCatalog (structure

Export parameters
Return
InfoObjCatList

Table of the InfoObjectCatalogs (according to selection
conditions) with long text descriptions (structure

*HW'HWDLO
The
*HW'HWDLO
method delivers detailed information on the InfoObjectCatalog. This
method is implemented in function module %$3,B,2%&B*(7'(7$,/.

Import parameters
InfoObjCat
Objvers
Export parameters
Details
InfoObjects
Return
6$3$*
Version of the InfoObjectCatalog (A, D)

,QIR6RXUFH5HTXHVW
.H\DWWULEXWHV
0HWKRGV
*HW6WDWXV
The Business Object ,QIR6RXUFH5HTXHVW 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 *HW6WDWXV.
The
RequestID
*HW6WDWXV
Unique ID of the request
method determines the actual status of an InfoSourceRequest. This
method is implemented in function module %$3,B,65(48(67B*(767$786

Import parameters
RequestID
Export parameters
TechStatus
TechInfo
QualStatus
QualInfo
Return
6$3$*
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)

,QIR3DFNDJH
The Business Object ,QIR3DFNDJH 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.
.H\DWWULEXWHV
InfoPackage
Unique name of the InfoPackage
$WWULEXWHV
Details
InfoPackage details as described by the structure

BAPI6109
5HIHUHQFHVWUXFWXUHV
0HWKRGV
&UHDWH)URP5HIHUHQFH
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
The &UHDWH method gives the possibility to create a new InfoPackage. This method is
implemented in function module %$3,B,3$.B&5($7(
Import parameters
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Export parameters
InfoPackage
Return
&UHDWH
BAPI6109
BAPI6109BTCH
BAPI6109DEST
BAPI6109DSSL
BAPI6109FILE
BAPI6109HIE
BAPI6109IC
BAPI6109L
BAPI6109SEL
BAPI6109TCP
The
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
&UHDWH)URP5HIHUHQFH
on basis of an already existing one. This method is implemented in function module

%$3,B,3$.B&5($7(B)520B5()
Import parameters
InfoPackageRef
Text
Export parameters
InfoPackage
Return
6$3$*
method gives the possibility to create a new InfoPackage
ID of the referenced InfoPackage

Description of the InfoPackage
ID of the created InfoPackage

&KDQJH
The &KDQJH method changes the actual definition of an InfoPackage. This method is
implemented in function module %$3,B,3$.B&+$1*(
Import parameters
InfoPackage
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Export parameters
Return
*HW/LVW
The *HW/LVW method delivers a list of InfoPackages according to the selection criteria
(with describing texts). This method is implemented in function module
%$3,B,3$.B*(7/,67
Import parameters
JobStatus
SelInfoSource
SelDataSource
SelSourceSystem
SelTextLong
Status of the scheduled job

Selection criteria for the InfoSources (structure
)

Selection criteria for the DataSources (structure
)

Selection criteria for the SourceSystems (structure
)
Selection criteria for the long text description of the InfoPackages

)
(structure
Export parameters
Return
InfoPackageList
*HW'HWDLO
The
*HW'HWDLO

Table of the InfoPackages (according to selection conditions) with

)
long text descriptions (structure
method delivers detailed information for an InfoPackage. This
method is implemented in function module %$3,B,3$.B*(7'(7$,/.

Import parameters
InfoPackage
Export parameters
Details
SchedulingParams
Destinations
FileParams
HieParams
Selections
InfoCubes
ThirdPartyParams
Return
6FKHGXOH
6$3$*
The
6FKHGXOH
method gives the possibility to schedule an InfoPackage with the
previously defined parameters. This method is implemented in function module

%$3,B,3$.B67$57

Import parameters
InfoPackage
Export parameters
RequestID
Return
&DQFHO6FKHGXOH
The
&DQFHO6FKHGXOH
ID of the generated request
method gives the possibility to abort an already scheduled
loading process that is not yet started. This method is implemented in function
module %$3,B,3$.B6723
Import parameters
InfoPackage
Export parameters
Return
6$3$*

$%$3'LFWLRQDU\6WUXFWXUHV
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.
%$3,'5
The dictionary structure %$3,'5 is used for data request details.

Field name
REQUEST
INFOSOURCE
SOURCESYSTEM
REQUESTTYPE
REQUESTDATE
REQUESTTIME
REQUESTUSER
UPDATEMODE
REQUESTSTATUS
REQUESTINFO
%$3,,2
Type
CHAR
CHAR
CHAR
CHAR
DATS
TIMS
CHAR
CHAR
CHAR
CHAR
%$3,
Type
CHAR
Length
30
Description
Name of the InfoObject
The dictionary structure %$3, represents the details of an InfoPackage.

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
6$3$*
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
The dictionary structure %$3,,2 represents a list of InfoObjects.

Field name
INFOOBJECT
Length
30
30
10
1
8
6
12
2
1
120
Description
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.

%$3,%7&+
The dictionary structure %$3,%7&+ represents the scheduling parameters of an

InfoPackage.
%$3,'(67
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
EXIT_CALL
CHAR
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)
In the dictionary structure %$3,'(67 it is possible to specify the destination of

the data.
%$3,),/(
Field name
ONLYENTRANCE
ONLYCUBETAB
PARALLEL
Type
CHAR
CHAR
CHAR
Length
1
1
1
CUBEAFTERODS
CHAR
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)
In the dictionary structure %$3,),/( it is possible to specify the parameters for

a load from a flat file.
6$3$*
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

internal format
%$3,+,(
In the dictionary structure
%$3,+,(
it is possible to specify the hierarchy to be
loaded.
Field name
HIENM
HIEVERS
HIEDATETO
HIEDATEFROM
HIECLASS
NEW_HIENAME_ON
NEW_HIENM
%$3,,&
Type
CHAR
CHAR
DATS
DATS
CHAR
CHAR
CHAR
Length
30
3
8
8
4
1
30
%$3,,&
Description
Name of the hierarchy
Version of the hierarchy
Valid until
Valid from
Hierarchy class
New hierarchy name wanted?
New name of the hierarchy
it is possible to specify the InfoCubes that
should be updated during the load process.

Field name
INFOCUBE
LOADCUBE
DELETEALLBEFORE
%$3,6(/
Type
CHAR
CHAR
CHAR
Length
30
1
1
%$3,6(/
Description
Name of the InfoCube
InfoCube should be updated
Delete the whole cube content before
loading data to the cube
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
LOW
HIGH
CHAR
CHAR
45
45
The dictionary structure
%$3,7&3
Description
Field name
InfoObject name
Selection operator (see ranges tables)
(only I useful)
(only EQ or BT useful)
Lower bound
Upper bound
represents the parameters needed for the
rd
%$3,7&3
access to the 3 party system.

Field name
RFCFIELDNM
RFCVALUE
RFCUSER
PASSWORD
%$3,
Type
CHAR
CHAR
CHAR
CHAR
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
The dictionary structure %$3, represents the details of an InfoCube.

Field name
INFOCUBE
OBJVERS
TEXTLONG
OBJSTAT
CONTREL
6$3$*
Length
30
128
32
8
Type
CHAR
CHAR
CHAR
CHAR
CHAR
Length
30
1
60
3
6
Description
InfoCube
Objectversion
Long text
Objectstatus
Content release

%$3,,2
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
AUTOCOMPRFL
CHAR
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
%$3,,2
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)
represents the list of InfoObjects of an
InfoCube.
Field name
INFOCUBE
OBJVERS
POSIT
INFOOBJECT
IOBJTP
ATRNAVFL
%$3,',
Type
CHAR
CHAR
NUMC
CHAR
CHAR
CHAR
Description
InfoCube
Object version
Position of the field in the structure / table
Type of an InfoObject
The InfoObject is a navigation attribute
The dictionary structure %$3,', represents the dimensions of an InfoCube.

Field name
INFOCUBE
OBJVERS
DIMENSION
TEXTLONG
IOBJTP
LINITFL
6$3$*
Length
30
1
4
30
3
1
Type
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
Length
30
1
30
60
3
1
Description
InfoCube
Object version
Dimensionname
Long description
Flag: Line item dimension

%$3,',2
The dictionary structure %$3,',2 represents the InfoObjects of a dimension of

an InfoCube.
Field name
INFOCUBE
OBJVERS
DIMENSION
POSIT
INFOOBJECT
ATRNAVFL
%$3,/
Type
CHAR
CHAR
CHAR
NUMC
CHAR
CHAR
Description
InfoCube
Object version
Dimensionname
Position of the field in the structure / table
The InfoObject is a navigation attribute
The dictionary structure %$3,/ is used to provide a list of InfoCubes.

Field name
INFOCUBE
OBJVERS
TEXTLONG
OBJSTAT
ACTIVFL
INFOAREA
CUBETYPE
%$3,6/
Length
30
1
30
4
30
1
Type
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
CHAR
%$3,6/
Length
30
1
60
3
1
30
1
Description
InfoCube
Object version
Long description
Objectstatus
Active and modified version identical
InfoArea
InfoCube type
is used for the specification of selection
criteria for InfoCubes.

Field name
SIGN
OPTION
INFOCUBELOW
INFOCUBEHIGH
%$3,
Type
CHAR
CHAR
CHAR
CHAR
Description
InfoCube (lower bound)
InfoCube (upper bound)
The dictionary structure %$3, represents the details of an InfoObjectCatalog.

Field name
INFOOBJCAT
OBJVERS
TEXTLONG
OBJSTAT
CONTREL
CONTTIMESTMP
OWNER
BWAPPL
IOBJTP
INFOAREA
TSTPNM
TIMESTMP
%$3,,2
Length
1
2
30
30
Type
CHAR
CHAR
CHAR
CHAR
CHAR
DEC
CHAR
CHAR
CHAR
CHAR
CHAR
DEC
%$3,,2
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)
InfoArea
Last changed by
UTC time stamp in short form
(YYYYMMDDhhmmss)
represents the list of InfoObjects of an
InfoObjectCatalog.
Field name
INFOOBJCAT
OBJVERS
INFOOBJECT
%$3,/
Type
CHAR
CHAR
CHAR
Description
InfoObjectCatalog
Object version
The dictionary structure %$3,/ is used to provide a list of InfoObjectCatalogs.

Field name
INFOCUBE
OBJVERS
TEXTLONG
6$3$*
Length
30
1
30
Type
CHAR
CHAR
CHAR
Length
30
1
60
Description
InfoCube
Object version
Long description

OBJSTAT
IOBJTP
INFOAREA
%$3,6/
CHAR
CHAR
CHAR
%$3,6/
3
3
30
Object status
InfoArea
is used for the specification of selection
criteria for InfoObjectCatalogs.

Field name
SIGN
OPTION
INFOOBJCATLOW
INFOOBJCATHIGH
6$3$*
Type
CHAR
CHAR
CHAR
CHAR
Length
1
2
30
30
Description
InfoObjectCatalog (lower bound)
InfoObjectCatalog (upper bound)

Stagingbapi 20 PDF

Caricato da

Informazioni sul documento

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Stagingbapi 20 PDF

Caricato da

Copyright:

Formati disponibili

BAPIs of the

SAP Business Information Warehouse

6WDJLQJ BAPIs of the

Copyright 2000 SAP AG. All rights reserved.

The original of this document is stored under the file

6WDJLQJ BAPIs of the

'DWD3URYLGHU  

,QIR2EMHFW  

,QIR2EMHFW&DWDORJ  

6WDJLQJ BAPIs of the

,QIR6RXUFH5HTXHVW  

,QIR3DFNDJH  

6WDJLQJ BAPIs of the

Knowledge of the concept of the Staging Engine of the SAP Business

Knowledge in the use of BAPIs in general and in the selected development

However, it is not necessary to have knowledge in the creation of IDocs or generally

Select Tools ABAP Workbench Function Builder from the menu

Enter the name of the desired function module

Select menu item Utilities -> RFC interface -> Generate

Please note, that for the function modules BAPI_ISOURCE_DP_REQUEST,

BAPI_ISOURCE_DP_GET_HELPVALUES you will have to generate the server

6WDJLQJ BAPIs of the

6WDJLQJ BAPIs of the

The Business Object ,QIR6RXUFH0DVWHU;IHU(BUS6104) has a new method

The Business Object ,QIR6RXUFH7UDQV;IHU(BUS6106) has a new method

The Business Object 'DWD3URYLGHU(BUS6107) is replaced in 2.0 by the

The Business Object ,QIR2EMHFW(BUS6108) has new methods for creating,

The new Business Object ,QIR&XEH(BUS6112) encapsulates the properties of

The new Business Object ,QIR2EMHFW&DWDORJ(BUS6113) encapsulates the

The new Business Object ,QIR6RXUFH5HTXHVW(BUS6114) encapsulates the

The new Business Object ,QIR3DFNDJH(BUS6109) encapsulates the properties

6WDJLQJ BAPIs of the

The Business Object

encapsulates the attributes and methods

method gives the possibility to activate the transfer structure for

6WDJLQJ BAPIs of the

The Business Object

encapsulates the attributes and methods

communication structure. This method is implemented in function module

6WDJLQJ BAPIs of the

The Business Object

encapsulates a data request from SAP Business

Information Warehouse to a source system. The implementation of this Business

(for the method

). Simple RFC Server programs, that can be used as a basis

The typical scenario for this interface is the following:

Business Information Warehouse

business interface. Popular examples for these

6WDJLQJ BAPIs of the

method of the business interface and shows the

method of the 5HPRWH,QIR6RXUFH3URYLGHU business interface. Parts of the request are

data request details

method sends a data request to the source system. An

6WDJLQJ BAPIs of the

Unique ID of the data request

Standard BAPI return parameter. For available standard error

Selection criteria for transaction data and master data attributes

method retrieves a table of parameters needed by the

Standard BAPI return parameter. For available standard error

Definition of the application-based parameters (structure

method retrieves a table of help values for fields of the

Name of the selection field

List of the already selected values for other fields (structure

'DWD3URYLGHU

,QIR2EMHFW

,QIR2EMHFW&DWDORJ

,QIR6RXUFH5HTXHVW

,QIR3DFNDJH

implemented in function module %$3,B,2%-B&5($7(

method is implemented in function module %$3,B,2%-B&+$1*(

implemented in function module %$3,B&8%(B&5($7(

method is implemented in function module %$3,B&8%(B&+$1*(

method is implemented in function module %$3,B,2%&B&5($7(

method is implemented in function module %$3,B,2%&B&+$1*(

method is implemented in function module %$3,B,65(48(67B*(767$786

The dictionary structure %$3,'5 is used for data request details.

The dictionary structure %$3, represents the details of an InfoPackage.

The dictionary structure %$3,,2 represents a list of InfoObjects.