Professional Documents
Culture Documents
Version 2.0
GA
31.01.2000
Copyright
Contents
History Copyright 2000 SAP AG. All rights reserved.
1 Introduction............................................5
Prerequisites............................................................5
Certification.............................................................6
Create 14
Change 14
Activate 14
GetList 15
GetDetail 15
InfoObjectCatalog...................................................16
Key attributes.......................................................................16
Attributes.............................................................................16
Reference structures............................................................16
Methods...............................................................................16
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 20
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
Prerequisites
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 3 rd 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 for the use of the Staging BAPIs of the SAP Business Information
Warehouse are:
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:
Certification
BAPI_ISOURCE_DP_GET_HELPVALUES you will have to generate the server
sample code instead of the client sample code.
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.
InfoSourceMaste
rXfer
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:
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.
Activate Activate
system. The new method makes it possible to activate the transfer structure for
attributes and texts.
The Activate method gives the possibility to activate the transfer structure for
attributes and texts. This method is implemented in function module
BAPI_ISOURCE_MD_T_ACTIVATE.
Import parameters
InfoSource InfoSource name
SourceSystem Source system name
LoadMethod Load method (T for TRFC, I for IDoc)
Export parameters
Return Standard BAPI return parameter
The Activate method gives the possibility to activate the transfer structure and the
communication structure. This method is implemented in function module
BAPI_ISOURCE_TD_T_ACTIVATE.
Import parameters
InfoSource InfoSource name
SourceSystem Source system name
LoadMethod Load method (T for TRFC, I for IDoc)
Export parameters
Return Standard BAPI return parameter
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 3 rd Party provider or in
one of the customers 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.
Scenario
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.
RFC Server
Scheduler
R e m o te In fo S o u r c e P r o v id e r .G e tP a r a m e te r D e fin itio n
R e m o te In fo S o u r c e P r o v id e r .G e tH e lp v a lu e s
M e ta d a ta
Extraction Engine
R e m o te In fo S o u rc e P ro v id e r.R e q u e s tIn fo S o u rc e D a ta
In fo S o u r c e T r a n s X fe r .G e tD e ta il
M e ta d a ta
Staging BAPI
D a ta
In fo S o u rc e T ra n s X fe r .S e n d D a ta
D a ta
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.
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.
RequestInfoSourceData GetParameterDefinition
The reference structures in the ABAP Dictionary for this Business Object are:
BAPI6107DR data request details
BAPI6107DA data selection details
BAPI6107LA text selection details
BAPI6107HI hierarchy selection details
BAPI6107PA request parameters
BAPI6107PD parameter definition
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
Change
Create
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 Name of the selection field
Langu Language for which the help values should be delivered
Export parameters
Return Standard BAPI return parameter. For available standard error messages
please refer to the online documentation.
Tables
PreviousSelList List of the already selected values for other fields (structure
BAPI6107PA)
HelpValuesList List of possible values for the selection field (structure BAPI6107HV)
The Business Object InfoObject encapsulates the logical properties of an
InfoObject. The new methods include the creation, change and activation of
InfoObjects.
InfoObject Unique name of the InfoObject
The new reference structures in the ABAP Dictionary for this Business Object is:
BAPI6108IO List of InfoObjects
The Create method gives the possibility to create a new InfoObject. This method is
implemented in function module BAPI_IOBJ_CREATE.
Import parameters
Details Properties of the InfoObject (structure BAPI6108)
Compounds Compound InfoObjects of the InfoObject (structure BAPI6108CM)
Attributes Attributes of the InfoObject (structure BAPI6108AT)
NavigationAttributes Navigationattributes of the InfoObject (structure BAPI6108AN)
Export parameters
InfoObject ID of the InfoObject
Return Standard BAPI return parameter (here as a table)
The Change method changes the actual metadata definition of an InfoObject. This
method is implemented in function module BAPI_IOBJ_CHANGE.
Import parameters
InfoObject ID of the InfoObject
Details Properties of the InfoObject (structure BAPI6108)
Compounds Compound InfoObjects of the InfoObject (structure BAPI6108CM)
Attributes Attributes of the InfoObject (structure BAPI6108AT)
NavigationAttributes Navigationattributes of the InfoObject (structure BAPI6108AN)
Export parameters
Return Standard BAPI return parameter (here as a table)
ActivateMultiple Reference
Key structures
Attributes
attributes
Methods
InfoCube Create
The new reference structures in ABAP Dictionary for this Business Object are:
BAPI6112 Details of an InfoCube
BAPI6112IO InfoObjects of an InfoCube
BAPI6112DI Dimensions of an InfoCube
BAPI6112DIO InfoObjects of the Dimensions of an InfoCube
BAPI6112L List of InfoCubes
BAPI6112SL Selection criterias for InfoCubes
The Create method gives the possibility to create a new InfoCube. This method is
implemented in function module BAPI_CUBE_CREATE.
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 Version of the InfoCubes to be selected (A, M, D, %)
Cubetype Type of the InfoCubes to be selected (B, R, %)
SelInfoCube Selection criteria for the name of the InfoCube (structure
BAPI6112SL)
SelTextLong Selection criteria for the long text description of the InfoCube
(structure BAPI6100SL)
Export parameters
Return Standard BAPI return parameter
InfoCubeList 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 implemented in function module BAPI_CUBE_GETDETAIL.
Import parameters
InfoCube ID of the InfoCube
Objvers Version of the InfoCube (A, M, D)
Export parameters
Details Properties of the InfoCube (structure BAPI6112)
InfoObjects InfoObjects of the InfoCube (structure BAPI6112IO)
Dimensions Dimensions of the InfoCube (structure BAPI6112DI)
DimensionInfoObjects InfoObjects of the Dimensions (structure BAPI6112DIO)
Return Standard BAPI return parameter
Change
GetList
Create
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.
The new reference structures in ABAP Dictionary for this Business Object are:
BAPI6113 Details of an InfoObjectCatalog
BAPI6113IO InfoObjects of an InfoObjectCatalog
BAPI6113L List of InfoObjectCatalogs
BAPI6113SL Selection criterias for InfoObjectCatalogs
The Create method gives the possibility to create a new InfoObjectCatalog. This
method is implemented in function module BAPI_IOBC_CREATE.
Import parameters
Details Properties of the InfoObjectCatalog (structure BAPI6113)
InfoObjects InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
Export parameters
InfoObjCat ID of the InfoObjectCatalog
Return Standard BAPI return parameter (here as a table)
The Change method changes the actual definition of an InfoObjectCatalog. This
method is implemented in function module BAPI_IOBC_CHANGE.
Import parameters
InfoObjCat ID of the InfoObjectCatalog
Details Properties of the InfoObjectCatalog (structure BAPI6113)
InfoObjects InfoObjects of the InfoObjectCatalog (structure BAPI6113IO)
Export parameters
Return Standard BAPI return parameter (here as a table)
The GetList method delivers InfoObjectCatalogs according to the selection criteria
(with describing texts). This method is implemented in function module
BAPI_IOBC_GETLIST.
The new reference structures in ABAP Dictionary for this Business Object are:
BAPI6109 Details of an InfoPackage
BAPI6109BTCH Scheduling parameters
BAPI6109DEST Destination of the data
BAPI6109DSSL Selection criterias for DataSource
Methods Change
CreateFromReference
Create
BAPI6109FILE Parameters for loading from flat file
BAPI6109HIE Parameters for loading of hierarchies
BAPI6109IC InfoCubes to be updated
BAPI6109L List of InfoPackages
BAPI6109SEL Selection parameters
BAPI6109TCP Third Party parameters
The Create method gives the possibility to create a new InfoPackage. This method
is implemented in function module BAPI_IPAK_CREATE.
Import parameters
Details Properties of the InfoPackage (structure BAPI6109)
SchedulingParams Scheduling parameters (structure BAPI6109BTCH)
Destinations Destination of the data (structure BAPI6109DEST)
FileParams Parameters for loading from flat file (structure BAPI6109FILE)
HieParams Parameters for loading hierarchies (structure BAPI6109HIE)
Selections Selection parameters (structure BAPI6109SEL)
InfoCubes InfoCubes to be updated (structure BAPI6109IC)
ThirdPartyParams Third Party parameters (structure BAPI6109TCP)
Export parameters
InfoPackage ID of the InfoPackage
Return Standard BAPI return parameter
The CreateFromReference method gives the possibility to create a new
InfoPackage on basis of an already existing one. This method is implemented in
function module BAPI_IPAK_CREATE_FROM_REF.
Import parameters
InfoPackageRef ID of the referenced InfoPackage
Text Description of the InfoPackage
Export parameters
InfoPackage ID of the created InfoPackage
Return Standard BAPI return parameter
The Change method changes the actual definition of an InfoPackage. This method
is implemented in function module BAPI_IPAK_CHANGE.
Import parameters
InfoPackage ID of the InfoPackage
Details Properties of the InfoPackage (structure BAPI6109)
SchedulingParams Scheduling parameters (structure BAPI6109BTCH)
Destinations Destination of the data (structure BAPI6109DEST)
FileParams Parameters for loading from flat file (structure BAPI6109FILE)
HieParams Parameters for loading hierarchies (structure BAPI6109HIE)
Selections Selection parameters (structure BAPI6109SEL)
InfoCubes InfoCubes to be updated (structure BAPI6109IC)
ThirdPartyParams Third Party parameters (structure BAPI6109TCP)
Export parameters
Return Standard BAPI return parameter
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.
BAPI6109
SDLSTRTTM
BAPI6109DESTTIMS 6BAPI6109FILE
Scheduled execution time BAPI6109HIE
EVENTID CHAR 32 Event-ID to start the package
EVENTPARM CHAR 64 Event-Parameter to start the package
PERIODIC CHAR 1 'X' for periodic job
CANCELPERIOD CHAR 10 Cancel the periodic job after 'XXX' runs
'0' or initial means no cancelation
EVENT_ID_OK CHAR 32 Event which will be raised by the package
after the load was OK (green light)
EVENT_PM_OK CHAR 64 Parameter of the Event after the load was
OK (green light)
EVENT_ID_ER CHAR 32 Event which will be raised by the package
after the load was not OK (red light)
EVENT_PM_ER CHAR 64 Parameter of the Event after the load was
not OK (red light)
FUNCTION_CALL CHAR 1 'X' means start the function module
'RSSM_START_SECOND_PROCESS'
after the load is finished (red or green)
EXIT_CALL CHAR 1 'X' means start the Business-Add-In after the
load is finished (red or green)
HIEDATEFROM
BAPI6109ICDATS 8 BAPI6109SEL
Valid from BAPI6112
HIECLASS CHAR 4 Hierarchy class
NEW_HIENAME_ON CHAR 1 New hierarchy name wanted?
NEW_HIENM CHAR 30 New name of the hierarchy BAPI6109TCP
DIMEDATCLS
BAPI6112IOCHAR 5 BW: Data class for dimension tables BAPI6112DIO
BAPI6112DI BAPI6112L
CUBESIZCAT CHAR 2 BW: Size category for InfoCube (fact)
tables
CUBEDATCLS CHAR 5 BW: Data class for InfoCube (fact)tables
BWSTATISTICS CHAR 1 Flag for BW statistics
BWSTATWHM CHAR 1 Flag for BW WHM statistics
AUTOQUALOKFL CHAR 1 Flag: Technical ok implies ok quality of the
request
AUTOROLLUPFL CHAR 1 Flag: Automatically roll up after the quality
ok
AUTOCOMPRFL CHAR 1 Flag: Automatically compress after the roll-
up
CLEAR_INDEX CHAR 1 Internal use
DELTA_INDEX CHAR 1 Internal use
REBUILD_STAT CHAR 1 Internal use
DELTA_STAT CHAR 1 Internal use
PERCENTAGE NUMC 3 Internal use
NULLCOMP CHAR 1 Zero elimination in the summarization
module
REFUPDATE CHAR 1
READMODE CHAR 1 Read mode (read everything)
TSTPNM CHAR 12 Last changed by
TIMESTMP DEC 15 UTC time stamp in short form
(YYYYMMDDhhmmss)
The dictionary structure BAPI6112IO represents the list of InfoObjects of an
InfoCube.
Field name Type Length Description
INFOCUBE CHAR 30 InfoCube
OBJVERS CHAR 1 Object version
POSIT NUMC 4 Position of the field in the structure / table
INFOOBJECT CHAR 30 Name of the InfoObject
IOBJTP CHAR 3 Type of an InfoObject
ATRNAVFL CHAR 1 The InfoObject is a navigation attribute
The dictionary structure BAPI6112DI represents the dimensions of an InfoCube.
Field name Type Length Description
INFOCUBE CHAR 30 InfoCube
OBJVERS CHAR 1 Object version
DIMENSION CHAR 30 Dimensionname
TEXTLONG CHAR 60 Long description
IOBJTP CHAR 3 Type of an InfoObject
LINITFL CHAR 1 Flag: Line item dimension