SAP AG SAP Confidential - Version 3.5GA – 02.11.2005 Page 1 of 79
Version 3.5GA
02.11.2005
Staging BAPIs for the SAP Business Information Warehouse Specification
SAP Confidential
SAP AG
Neurottstr. 16
D-69190 Walldorf
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 2 of 79
Copyright 2005 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.
The original of this document is stored under the file BAPI.DOC.
Peter Schellenberger
Version 3.5GA Status 02.11.2005
Version 2.0GA Status 31.01.2000
Version 1.2GA Status 18.08.1998
Copyright
Original document
Author(s)
History
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 3 of 79
1 Organization................................................................ 9
Persons involved................................................................................. 9
Reference............................................................................................ 9
Terminology ........................................................................................ 9
2 Change History ............................................................. 10
3 Introduction ................................................................ 11
Basics .................................................................................................. 11
Hierarchies ........................................................................................ 15 Very simple customer hierarchy ....................................................... 16 Simple customer hierarchy ................................................................ 16 Customer hierarchy with intervals .................................................... 17 Hierarchy with multiple parents for one node............................... 18
Scenario ............................................................................................ 19 Limitations ............................................................................................. 21
Data types and formats ................................................................... 21
Certification ........................................................................................ 22
Prerequisites........................................................................................ 22
4 Staging Engine Business Objects ............................. 24
InfoSourceTrans ................................................................................ 25 Key attributes ....................................................................................... 25 Attributes ............................................................................................... 25 Reference structures........................................................................... 26 Methods ................................................................................................ 26 Create 26 Change 26 ExistenceCheck 26 GetStatus 27 GetDetail 27 GetList 27
InfoSourceTransXfer ......................................................................... 28 Key attributes ....................................................................................... 28 Attributes ............................................................................................... 28 Reference structures........................................................................... 28 Methods ................................................................................................ 29 Create 29 Change 29 Activate 29
Contents
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 4 of 79
ExistenceCheck 29 GetStatus 30 GetDetail 30 GetList 30 SendData 31 SendDataBinary 32
InfoSourceMaster ............................................................................. 33 Key attributes ....................................................................................... 33 Attributes ............................................................................................... 33 Reference structures........................................................................... 33 Methods ................................................................................................ 33 Create 33 Change 34 ExistenceCheck 34 GetStatus 34 GetDetail 34 GetList 35
InfoSourceMasterXfer ...................................................................... 36 Key attributes ....................................................................................... 36 Attribute................................................................................................. 36 Reference structures........................................................................... 37 Methods ................................................................................................ 37 Create 37 Change 37 Activate 38 ExistenceCheck 38 GetStatus 38 GetDetail 39 GetList 39 SendData 40 SendDataBinary 41 SendText 41 SendTextBinary 42
InfoSourceHirchyXfer ....................................................................... 44 Key attributes ....................................................................................... 44 Attributes ............................................................................................... 44 Reference structures........................................................................... 44 Methods ................................................................................................ 44 Create 44 Change 45 ExistenceCheck 45 GetDetail 45
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 5 of 79
GetList 46 SendData 46 SendDataBinary 47
RemoteInfoSource Provider............................................................. 48
Scenario .............................................................................................. 48 Key attributes ....................................................................................... 48 Attributes ............................................................................................... 48 Reference structures........................................................................... 49 Methods................................................................................................... 49 RequestInfoSourceData 49 GetParameterDefinition 49 GetParameterHelpValues 50 SendLog 50
SourceSystem ................................................................................... 51 Key attributes ....................................................................................... 51 Attributes ............................................................................................... 51 Reference structures........................................................................... 51 Methods ................................................................................................ 51 Create 51 Methods ................................................................................................ 52 ExistenceCheck 52 GetDetail 52 GetList 52
InfoObject ......................................................................................... 53 Key attributes ....................................................................................... 53 Attributes ............................................................................................... 53 Reference structures........................................................................... 53 Methods ................................................................................................ 53 Create 53 Change 53 GetDetail 53 GetList 54 ActivateMultiple 54
InfoObject ........................................................................................... 55 Key attributes........................................................................................... 55 Attributes................................................................................................. 55 Reference structures.................................................................................. 55 Methods................................................................................................... 55 Create 55 Change 55 ActivateMultiple 55
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 6 of 79
InfoCube ............................................................................................. 56 Key attributes........................................................................................... 56 Attributes................................................................................................. 56 Reference structures.................................................................................. 56 Methods................................................................................................... 56 Create 56 Change 56 Activate 57 GetList 57 GetDetail 57
InfoObjectCatalog............................................................................... 57 Key attributes........................................................................................... 58 Attributes................................................................................................. 58 Reference structures.................................................................................. 58 Methods................................................................................................... 58 Create 58 Change 58 GetList 58 GetDetail 59
InfoSourceRequest .............................................................................. 59 Key attributes........................................................................................... 59 Methods................................................................................................... 59 GetStatus 59
InfoPackage......................................................................................... 59 Key attributes........................................................................................... 59 Attributes................................................................................................. 60 Reference structures.................................................................................. 60 Methods................................................................................................... 60 Create 60 CreateFromReference 60 Change 60 GetList 61 GetDetail 61 Schedule 61 CancelSchedule 62
DataStore (ODS Object) ...................................................................... 62 Key attributes........................................................................................... 62 Attributes................................................................................................. 62 Reference structures.................................................................................. 62 Methods................................................................................................... 62 Create 62 Change 63
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 7 of 79
Activate 63 GetList 63 GetDetail 63 ReadDataUc 64
ABAP Dictionary Structures.............................................................. 65 BAPI6100DA........................................................................................... 65 BAPI6100DARAW.................................................................................. 65 BAPI6100FL............................................................................................. 65 BAPI6100FLS........................................................................................... 65 BAPI6100FLX .......................................................................................... 66 BAPI6100SL ............................................................................................ 66 BAPI6101 ................................................................................................ 66 BAPI6101L .............................................................................................. 66 BAPI6101SL ............................................................................................ 66 BAPI6102 ................................................................................................ 67 BAPI6102L .............................................................................................. 67 BAPI6102SL ............................................................................................ 67 BAPI6103 ................................................................................................ 67 BAPI6103L .............................................................................................. 68 BAPI6103SL ............................................................................................ 68 BAPI6104 ................................................................................................ 68 BAPI6104L .............................................................................................. 68 BAPI6105 ................................................................................................ 69 BAPI6105L .............................................................................................. 69 BAPI6105SL ............................................................................................ 69 BAPI6106 ................................................................................................ 69 BAPI6106L .............................................................................................. 70 BAPI6107DA........................................................................................... 70 BAPI6107DP........................................................................................... 70 BAPI6107DR........................................................................................... 70 BAPI6107DR........................................................................................... 70 BAPI6107HI............................................................................................. 71 BAPI6107LA............................................................................................ 71 BAPI6107PA ........................................................................................... 71 BAPI6107PD........................................................................................... 71 BAPI6107HP ........................................................................................... 71 BAPI6108 ................................................................................................ 71 BAPI6108AN........................................................................................... 72 BAPI6108AT............................................................................................ 72 BAPI6108CM.......................................................................................... 72 BAPI6108IO............................................................................................ 72 BAPI6108L .............................................................................................. 72
Staging BAPIs
for the
SAP Business Information Warehouse
Contents
SAP AG Version 3.5GA – 02.11.2005 Page 8 of 79
BAPI6108SL ............................................................................................ 72 BAPI6109 ................................................................................................ 72 BAPI6109BTCH...................................................................................... 73 BAPI6109DEST....................................................................................... 73 BAPI6109FILE........................................................................................ 73 BAPI6109HIE.......................................................................................... 74 BAPI6109IC............................................................................................ 74 BAPI6109SEL......................................................................................... 74 BAPI6109TCP......................................................................................... 74 BAPI6112................................................................................................ 75 BAPI6112IO............................................................................................ 75 BAPI6112DI............................................................................................ 76 BAPI6112DIO......................................................................................... 76 BAPI6112L.............................................................................................. 76 BAPI6112SL............................................................................................ 76 BAPI6113................................................................................................ 76 BAPI6113IO............................................................................................ 77 BAPI6113L.............................................................................................. 77 BAPI6113SL............................................................................................ 77 BAPI6114MSG........................................................................................ 77 BAPI6116................................................................................................ 77 BAPI6116IO............................................................................................ 78 BAPI6116NA........................................................................................... 78 BAPI6116IN and BAPI6116II.................................................................. 78 BAPI6116L.............................................................................................. 78 BAPI6116SL............................................................................................ 78 BAPI6116IOLS........................................................................................ 79 BAPI6116SLIO........................................................................................ 79 BAPI6116DAUC and BAPI6116DALO................................................... 79
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG SAP Confidential - Version 3.5GA – 02.11.2005 Page 9 of 79
1 Organization
Project team / Development team:
Name Company Project role(s) / Comments
Stefan Sigg SAP AG Program director
Rainer Hoeltke SAP AG Development manager
Matthias Stein SAP AG Quality manager
Peter Schellenberger SAP AG Author, developer
You can find more information about BAPIs available in the SAP Developers
Network (SDN) web site: http://sdn.sap.com
Use key words like
• BAPI Introduction and Overview • BAPI Programming Guide • BAPI Java Class Library • BAPI C++ Class Library to find relevant documents
You can find further information on the terminology to be used in the SAP Business
Information Warehouse in:
• SAP Business Information Warehouse – Glossary • SAP Business Information Warehouse – Documentation
With the next release NetWeaver 04s the description ODS-Object will be replace
by DataStore. In this context the description of Business Object ODS Object (
BUS6116 ) will also be replaced by DataStore. In this documentation we already use
the new description DataStore instead of ODS Object.
In release Netweaver 04s the tool AdministratorWorkbench is renamed as
DataWareHousingWorkbench.
In release Netweaver 04s there is a new InfoSource. The old one is renamed as 3.x
InfoSource. In this document we use the term InfoSource for the 3.x InfoSource..
Persons involved
Reference
Terminology
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 10 of 79
2 Change History
The following Business Objects methods are new in Release 3.50of the SAP
Business Information Warehouse:
• InfoSourceMasterXfer The Business Object InfoSourceMasterXfer (BUS6104) has new methods SendDataBinary, SendTextBinary.
• InfoSourceTransXfer The Business Object InfoSourceTransXfer (BUS6106) has a new method SendDataBinary.
• InfoSourceHirchyXfer
The Business Object InfoSourceHirchyXfer (BUS6105) has a new method SendDataBinary.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 11 of 79
3 Introduction
This document describes the Staging BAPIs of the SAP Business Information
Warehouse, which provide an open interface to the staging engine of this product.
The BAPIs described in this document include methods for updating and retrieving
meta data for InfoObjects, DataStore Objects (ODS-Objects), 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.
The basic concept for the staging engine of the SAP Business Information
Warehouse is the so-called InfoSource. An InfoSource is a logical data source that
contains a number of InfoObjects (fields) that logically belong together. InfoSources
can be defined for transaction and master data, master data InfoSources can include
attributes, texts and hierarchies.
An InfoSource consists of a logical data source which is independent of the source
systems and a physical data source (also called a TransferInfoSource) which actually
is an instance of the InfoSource for one source system and describes the specifics of
an InfoSource on source system. The following diagrams visualize the InfoSource
concept for the available types of transaction and master data.
Basics
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 12 of 79
InfoCubes
Update Rules
Business Information Warehouse
SAP Source System BAPI Source System
InfoSourceTrans
InfoSourceTransXfer
Transfer Rules
Transfer Structure
Extract Structure
Communication Structure
Transfer Structure
Union of Extract Structures
Extract StructureTransfer Structure
(= Extract Structure)
Transfer Structure
InfoSource for transaction data
In case of transaction data incoming data records are transformed using the
transformation rules specified for this combination of InfoSource and SourceSystem
and those specified for each InfoObject of the communication structure. Before
being written to the InfoCubes update rules are applied.
Please note: One InfoSource can be used to update several InfoCubes, one InfoCube
can be updated by several InfoSources which can be fed by several SourceSystems.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 13 of 79
Master data attribute table
Business Information Warehouse
SAP Source System BAPI Source System
InfoSourceMasterTransfer Rules
Transfer Structure Transfer Structure
Extract Structure
Communication Structure
Transfer Structure(= Extract Structure)
Transfer Structure
Union of Extract Structures
Extract Structure
InfoSourceMasterXfer
InfoSource for master data attributes
In case of master data attributes incoming data are also transformed using the
transformation rules specified for this combination of InfoSource and SourceSystem
and those specified for the InfoObjects in the communication structure. However,
instead of applying update rules, master data are written to the master data attribute
table directly.
Please note: One master data attribute InfoSource can fed by several SourceSystems.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 14 of 79
Master data text table
Business Information Warehouse
SAP Source System BAPI Source System
InfoSourceMasterTransfer Rules(only InfoObject
rules apply)
Transfer Structure Transfer Structure
Extract Structure
Communication Structure
Transfer StructureTransfer Structure
InfoSourceMasterXfer
InfoSource for master texts
In case of master data texts incoming data are only transformed using the
transformation rules specified for the InfoObjects of the communication structure.
Master data texts are written to the master data text table directly. Master data texts
are usually stored language dependent, this is why texts are not stored as ordinary
attributes.
Please note: One master data text InfoSource can fed by several SourceSystems.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 15 of 79
Master data hierarchy tables
Business Information Warehouse
SAP Source System BAPI Source System
Transfer Rules(only InfoObject Rules)
n Transfer Structures
n Communication Structures
1 Transfer Structuren Transfer Structures
InfoSourceHirchyXfer
1 Transfer Structure
InfoSource for master data hierarchies
In case of master data hierarchies incoming data are also only transformed using the
transformation rules specified for the InfoObjects in the communication structure.
Master data hierarchies are written to the master data hierarchy tables directly.
Please note: One master data hierarchy can only be fed by one SourceSystem.
The SAP Business Information Warehouse provides a very flexible way of handling
hierarchies. All available features are supported for the R/3 interface, the file
interface and the Staging BAPIs.
The transfer structure used for sending hierarchy data to the SAP Business
Information Warehouse depends on the characteristics of the specific hierarchy. As a
basis for the transfer structure the following template is used:
Field name Description NODEID Unique id for the hierarchy node (local to each hierarchy) INFOOBJECT Name of the InfoObject this hierarchy node refers to NODENAME Name of the key value of this hierarchy node LINK Flag: ‚X‘ = link node PARENTID Node id of the parent node CHILDID Node id of the first child node NEXTID Node id of the next sibling DATETO Date valid to (only used for hierarchies with time dependent nodes) DATEFROM Date valid from (only used for hierarchies with time dependent nodes) LEAFTO Key value to (only used for hierarchies with interval nodes) LEAFFROM Key value from (only used for hierarchies with interval nodes)
Hierarchies
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 16 of 79
LANGU Language (only used if there’s no text information available in the master data) TXTSH Short text (only used if there’s no text information available in the master data) TXTMD Medium length text (only used if there’s no text information available in the
master data) TXTLG Long text (only used if there’s no text information available in the master data)
This may best be illustrated by the sample hierarchy shown below:
6 - CUSTOMER 35 - CUSTOMER 2
7 - CUSTOMER 44 - CUSTOMER 1
2 - REGION 1 3 - REGION 2
1 - TOTAL
This hierarchy will have to be transferred to the SAP Business Information
Warehouse as shown in the following table (Initial value ‘00000000’ for IDs left out
for readability):
NODE ID
INFO OBJECT
NODE NAME
LINK PARENT ID
CHILD ID
NEXT ID
LANGU TXTSH TXTMD TXTLG
1 0HIER_NODE TOTAL 2 EN Total Total Total 2 0HIER_NODE REGION 1 1 4 3 Region 1 Region 1 Region 1 3 0HIER_NODE REGION 2 1 6 Region 2 Region 2 Region 2 4 0CUSTOMER CUSTOMER 1 2 5 5 0CUSTOMER CUSTOMER 2 2 6 0CUSTOMER CUSTOMER 3 3 7 7 0CUSTOMER CUSTOMER 4 3
Please note, that in this example we do not have a special InfoObject for the region.
In order to be able to display the texts ‘Region 1’ and ‘Region 2’ in a report, you will
have to send the two nodes as specified above.
Because the node name is a key value, it is not possible to specify mixed case or
lower case values for this field.
The DATETO, DATEFROM fields are not shown here but have to be specified, if
the nodes of the hierarchy are defined in the InfoObject definition as time
dependent.
The LEAFTO, LEAFFROM fields are described in an example below.
This may best be illustrated by the sample hierarchy shown below:
Very simple customer
hierarchy
Simple customer
hierarchy
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 17 of 79
6 - CUSTOMER 35 - CUSTOMER 2
7 - CUSTOMER 44 - CUSTOMER 1
2 - REGION 1 3 - REGION 2
1 - TOTAL
This hierarchy will have to be transferred to the SAP Business Information
Warehouse as shown in the following table (Initial value ‘00000000’ for IDs left out
for readability):
NODE ID
INFO OBJECT
NODE NAME
LINK PARENT ID
CHILD ID
NEXT ID
LANGU TXTSH TXTMD TXTLG
1 0HIER_NODE TOTAL 2 EN Total Total Total 2 0REGION REGION 1 1 4 3 3 0REGION REGION 2 1 6 4 0CUSTOMER CUSTOMER 1 2 5 5 0CUSTOMER CUSTOMER 2 2 6 0CUSTOMER CUSTOMER 3 3 7 7 0CUSTOMER CUSTOMER 4 3
The difference between this and the previous is example is that in this case the region
has its own InfoObject called 0REGION. Text information to the region in this case
is read from the master data text table of the InfoObject 0REGION.
The DATETO, DATEFROM fields are not shown here but have to be specified, if
the nodes of the hierarchy are defined in the InfoObject definition as time
dependent.
The LEAFTO, LEAFFROM fields are described in the next example.
7 - CUSTOMER 36 - CUSTOMER 2 8 - CUSTOMER 4
5 - CUSTOMER 1
2 - REGION 13 - REGION 2
1 - TOTAL
8 - CUSTUMERS 5 - 10
4 - REGION 3
This hierarchy will have to be transferred to the SAP Business Information
Warehouse as shown in the following table:
Customer hierarchy with
intervals
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 18 of 79
NODE ID
INFO OBJECT
NODE NAME
LINK PARENT ID
CHILD ID
NEXT ID
LEAFFROM LEAFTO
1 0HIER_NODE TOTAL 2 2 0REGION REGION 1 1 5 3 3 0REGION REGION 2 1 7 4 4 0REGION REGION 3 1 9 5 0CUSTOMER CUSTOMER 1 2 6 6 0CUSTOMER CUSTOMER 2 2 7 7 0CUSTOMER CUSTOMER 3 3 8 8 0CUSTOMER CUSTOMER 4 3 9 9 0CUSTOMER INTERVAL1 4 Customer 5 Customer 10
The text fields have been left out to reduce the size of the table.
The SAP Business Information Warehouse also supports hierarchies with loops as
shown in the next example
5 - CUSTOMER 26 - CUSTOMER 34 - CUSTOMER 1
2 - REGION 1 3 - REGION 3
1 - TOTAL
8 - LOCATION 27 - LOCATION 1
To understand how the SAP Business Information Warehouse deals with this kind of
hierarchies, have a look at the following alternative graphical representation of the
hierarchy:
5 - CUSTOMER 2
7 - CUSTOMER 34 - CUSTOMER 1
2 - REGION 1 3 - REGION 2
1 - TOTAL
9 - LOCATION 28 - LOCATION 1
6 - CUSTOMER 2
NODE INFO NODE LINK PARENT CHILD NEXT
Hierarchy with multiple
parents for one node
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 19 of 79
ID OBJECT NAME ID ID ID 1 0HIER_NODE TOTAL 2 2 0REGION REGION 1 1 4 3 3 0REGION REGION 2 1 6 4 0CUSTOMER CUSTOMER 1 2 5 5 0CUSTOMER CUSTOMER 2 2 8 6 0CUSTOMER CUSTOMER 2 X 3 8 7 7 0CUSTOMER CUSTOMER 3 3 8 0LOCATION LOCATION 1 5 9 9 0LOCATION LOCATION 2 5
This chapter contains a basic scenario considered typical for the use of the staging
BAPIs. However, more complex (meta data update and upload) scenarios can easily
be implemented based upon these BAPIs.
The first thing to do in this basic scenario is to map the extracted data against the
transfer structure of an InfoSource defined in the SAP BW. This scenario applies to
transaction data as well as master data attribute InfoSources:
Business Information Warehouse Source System
Sta
ging
BA
PI
Meta data Meta data3r
d P
arty
Too
l
InfoSourceTransXfer.GetList
InfoSourceTransXfer.GetDetails
InfoSourceTransXfer.GetDetails
1. The source system calls the GetList method of an InfoSource to get a list of
available InfoSources from the SAP Business Information Warehouse. It may
then present this list in a dialog box and have the user select an InfoSource for
mapping it with the structure of the extracted data.
2. The mapping process is based on the layout of the transfer structure which can
be retrieved from the SAP Business Information Warehouse by calling the
GetDetail method of the InfoSource.
3. The next step is to actually extract data from the data sources, perform the
mapping defined in step one and then send the extracted data to the SAP BW.
This scenario – with minor modifications – applies to every type of InfoSource
supported by the SAP Business Information Warehouse.
Scenario
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 20 of 79
A typical scenario to request data form a 3rd Party system is the following:
Business Information Warehouse Source System
RemoteInfoSourceProvider.GetParameterDefinition
Staging BAPIMeta data
Data
RemoteInfoSourceProvider.RequestInfoSourceData
InfoSourceTransXfer.GetDetail
InfoSourceTransXfer.SendDataScheduler
RFC Server
Extraction Engine Meta data
Data
RemoteInfoSourceProvider.GetParamHelpValues
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 GetParameterHelpValues 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 for the 3rd Party selections.
Eventually 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.
In order to ensure that the extract structure exactly matches the current transfer
structure the source system has to call the GetDetails method of the requested
InfoSource to get the current transfer structure.
Extracted data can then be sent to the SAP Business Information Warehouse by
calling the SendData method of the requested InfoSource. The SendData method
supports sending any number of records per call (each call defining a data packet). It
is however recommended to send about 10.000 to 100.000 records per call.
Note: The loading scenario has been designed to work asynchronos. This means that
sending the request to 3rd Party system and returning the extracted data to the SAP
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 21 of 79
Business Information Warehouse are self-contained processes ( refer to description
of business interface RequestInfoSourceProvider ( IF6107) ).
Methods for the definition of transformation rules or the activation of transfer and
communication structures are currently not implemented. These functions remain in
the Administrator Workbench in the SAP Business Information Warehouse, as
expensive consistency and – in the case of transformation rules – syntax checks are
necessary.
The Staging BAPIs’ for sending master and transaction data to the SAP Business
Information Warehouse do not support sending data of a binary data type. The table
below shows for every ABAP data type, if it is supported and, if not, which data type
should be used to send such data:
Data type Internal data type
Supported Convert to Description
ACCP N Yes --- Posting period YYYYMM CHAR C Yes --- Character strings CLNT C Yes --- Client CUKY C Yes --- Currency key, referenced by CURR fields CURR P No CHAR Currency field, stored as DEC DATS D Yes --- Date field (YYYYMMDD) stored as
char(8) DEC P No CHAR Counter or amount field with comma and
sign FLTP F No CHAR Floating point number, accurate to 8 bytes INT1 X No NUMC 1-byte integer, integer number <= 254 INT2 X No NUMC 2-byte integer, only for length field before
VARC or RAW INT4 X No NUMC 4-byte integer, integer number with sign LANG C Yes --- Language key LCHR C No CHAR Long character string, requires preceding
INT2 field LRAW X No CHAR Long byte string, requires preceding INT2
field NUMC N Yes --- Character field with only digits PREC X No NUMC Precision of a QUAN field QUAN P No CHAR Quantity field, points to a unit field with
format UNIT RAW X No CHAR Uninterpreted sequence of bytes TIMS T Yes --- Time field (hhmmss), stored as char(6) VARC V No CHAR Long character string, no longer supported
from Rel. 3.0 UNIT C Yes --- Unit key for QUAN fields
To send numeric data to the SAP Business Information Warehouse, you will have to
use the usual, widely used data formats for character representations of numeric data.
An optional sign (-/+), a valid number (with an optional dot), and an ‘E’ for
exponent followed by the actual exponent as shown in the following examples:
Limitations
Data types and formats
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 22 of 79
12.34
–12.34
+12.34
–1.23E10
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 provided with Release 3.0 and 3.50 is
possible.
For further information – especially about the certification process for the 3.x BAPIs
- please contact your CSP manager.
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,
BAPI_ISOURCE_DP_GET_HELPVALPAR and
BAPI_ISREQUEST_SEND_LOG
Certification
Prerequisites
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 23 of 79
of the BAPI interface IF6107 you will have to generate the server sample code
instead of the client sample code.
The available Staging BAPIs of the SAP Business Information Warehouse could be
viewed inside the system with the BAPI Explorer (Transaction BAPI). Note the
filter has to be set to all to see all Staging Interfaces.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 24 of 79
4 Staging Engine Business Objects
The following Business Objects and - Interfaces for deploying a staging scenario are
available onwards Release 3.0 of the SAP Business Information Warehouse:
• InfoSourceTrans The Business Object InfoSourceTrans (BUS6102) encapsulates the properties of an InfoSource for transaction data, independent of an assignment to a source system, such as the field definitions of the communication structure.
• InfoSourceTransXfer The Business Object InfoSourceTransXfer (BUS6106) encapsulates the properties of an InfoSource for transaction data, that are specific for the characteristic of an InfoSource on a source system, such as the field definitions of all fields available on source system and the transfer structure.
• InfoSourceMaster The Business Object InfoSourceMaster (BUS6103) conforms with the Business Object InfosourceTrans, but refers to master data.
• InfoSourceMasterXfer The Business Object InfoSourceMasterXfer (BUS6104) conforms with the Business Object InfoSourceTransXfer, but refers to master data.
• InfoSourceHirchyXfer The Business Object InfoSourceHirchyXfer (BUS6105) encapsulates the properties of hierarchies for objects of Type InfoSourceMasterXfer.
• SourceSystem The Business Object SourceSystem (BUS6101) encapsulates the properties and methods of a source system.
• InfoObject
The Business Object InfoObject (BUS6108) encapsulates the properties and methods of an InfoObject.
• DataProvider/RemoteInfoSourceProvider
The Business Interface RemoteInfoSourceProvider (IF6107) encapsulates the properties and methods of a data request (Request) to a source system.
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 25 of 79
• DataStore (ODS Objeckt) The Business Object DataStore (BUS6116) encapsulates the properties of an DataStore and has methods for creating, changing, activating and reading.
• InfoCube The Business Object InfoCube (BUS6112) encapsulates the properties of an InfoCube and has methods for creating, changing and activating.
• InfoObjectCatalog The Business Object InfoObjectCatalog (BUS6113) encapsulates the properties of on InfoObjectCatalog and has methods for creating and changing.
• InfoSourceRequest The Business Object InfoSourceRequest (BUS6114) encapsulates the properties and methods of a data request from the BW to an external system.
• InfoPackage The Business Object InfoPackage (BUS6109) encapsulates the properties and methods of an InfoPackage and has methods for creating, changing and scheduling.
The Business Object InfoSourceTrans encapsulates those attributes and methods of
an InfoSource for transaction data which are independent of an assignment to a
source system.
The Business Object offers methods for creating and changing InfoSources, for
retrieving detail and status information, as well as retrieving lists of existing
InfoSources.
Just as in the Administrator Workbench, it is not possible to directly change field
information. Changes to field information are always performed by changing the
Transfer InfoSources (see Business Object InfoSourceTransXfer).
• InfoSource The technical name of the InfoSource • TextShort Short text for the InfoSource (in the logon language) • TextMedium Text of medium length for the InfoSource (in the
logon language) • TextLong Long text for the InfoSource (in the logon language) • CustomerDefined Flag: InfoSource is defined by the customer • Active Flag: InfoSource is active • ComStructure Name of the communication structure
InfoSourceTrans
Key attributes
Attributes
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 26 of 79
• ModificationDate Modification date of the communication structure • ModificationTime Modification time of the communication structure • ComStructureFields Fields of the communication structure • Fields Fields of the provider structure, corresponds to the
communication structure plus fields not used there
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6102 Detailed InfoSource information • BAPI6102L List of InfoSources including text information • BAPI6102SL Selection criteria for InfoSource names • BAPI6100SL Selection criteria for InfoSource long text descriptions • BAPI6100FL Detailed field information (ComStructureFields) • BAPI6100FLS List of usable InfoObjects (Fields)
The Create method creates a new InfoSource for transaction data. In this way,
created InfoSources are always indicated as being customer-specific. This method is
implemented in function module BAPI_ISOURCE_TD_CREATE.
Import parameters TextShort Descriptive short text TextMedium Medium length descriptive text
(optional, if not entered then short text is used) TextLong Long describing text
(optional, if not entered then short text is used) Export parameters InfoSource InfoSource name Return Standard BAPI result parameters
The Change method changes the describing text for the InfoSource. This method is
implemented in function module BAPI_ISOURCE_TD_CHANGE.
Import parameters InfoSource InfoSource name TextShort Descriptive short text TextMedium Medium length descriptive text
(optional, if not entered then short text is used) TextLong Long describing text
(optional, if not entered then short text is used) Export parameters Return Standard BAPI return parameters
The ExistenceCheck method checks the existence of an InfoSource. This method is
implemented in function module BAPI_ISOURCE_TD_EXISTS.
Import parameters InfoSource InfoSource name Export parameters Return Standard BAPI return parameters
Reference structures
Methods
Create
Change
ExistenceCheck
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 27 of 79
The GetStatus method delivers the status of the communication structure. This
method is implemented in function module BAPI_ISOURCE_TD_GETSTATUS.
Import parameters InfoSource Name of the InfoSource Export parameters ComStructure Name of the communication structure Active Flag: InfoSource is active Return Standard BAPI return parameters
The GetDetail method delivers detailed information on the InfoSource. This method
is implemented in function module BAPI_ISOURCE_TD_GETDETAIL.
The list of fields of the InfoSource is sorted by InfoObject names, the list of
communication structure fields is sorted by position numbers.
Import parameters InfoSource InfoSource name Export parameters TextShort InfoSource short text (in logon language) TextMedium Medium length text for the InfoSource (in logon language) TextLong InfoSource long text (in logon language) CustomerDefined Flag: InfoSource is defined by the customer ComStructure Name of the communication structure Active Flag: InfoSource is active ModificationDate Modification date of the communication structure ModificationTime Modification time of the communication structure Return Standard BAPI return parameters Tables Fields Available fields in the InfoSource (structure BAPI6100FLS) ComStructureFields Communication structure fields (as a rule this is a subset of the
Fields). Only filled if the communication is active (structure BAPI6100FL)
The GetList method delivers the selection criteria corresponding to the InfoSources
(with describing texts). This method is implemented in function module
BAPI_ISOURCE_TD_GETLIST. The list of the InfoSources is sorted by InfoSource
names.
Export parameters Return Standard BAPI return parameters Tables SelInfoSource Selection criteria for the name of the InfoSource (structure
BAPI6102SL) SelTextLong Selection criteria for the long text description of the InfoSource
(structure BAPI6100SL) InfoSourceList Table of the InfoSources (according to selection conditions) with
long text descriptions (structure BAPI6102L)
GetStatus
GetDetail
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 28 of 79
The Business Object InfoSourceTransXfer encapsulates the attributes and methods
of an InfoSource for transaction data, that are specific for the InfoSources on a
source system.
The Business Object provides methods for creating and changing Transfer
InfoSources, for retrieving detail and status information, retrieving lists of existing
TransferInfoSources as well as for the transmission of data for the InfoSource to the
SAP Business Information Warehouse in conjunction with the Business Object
DataProvider.
• InfoSource The technical InfoSource name • Source System The name of a source system from which the
InfoSource is filled • TextShort InfoSource short text (in logon language) • TextMedium Medium length text for the InfoSource (in logon
language) • TextLong InfoSource long text (in logon language) • CustomerDefined Flag: InfoSource is defined by the customer • FullUpdate Flag: The InfoSource supports the transmission of
complete datasets • DeltaUpdate Flag: The InfoSource supports the transmission of
updated data • Reloadable Flag: The InfoSource supports the retransmission of
data requests • Active Flag: InfoSource is active • TranStructure Name of the transfer structure • ModificationDate Modification date of the transfer structure • ModificationTime Modification time of the transfer structure • TranStructureFields Fields of the transfer structure • TranStructureFieldsX Change flags for field definitions of the transfer
structure (according to BAPI conventions)
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6106 Detailed InfoSource information • BAPI6106L List of InfoSources including text information • BAPI6106SL Selection criteria for InfoSource names • BAPI6100SL Selection criteria for InfoSource long text descriptions • BAPI6102SL Selection criteria for source systems • BAPI6100FL Detailed field information (TranStructureFields) • BAPI6100FLX Change flags for fields (TranStructureFieldsX) • BAPI6100DA Data records • BAPI6107DP Data request details
InfoSourceTransXfer
Key attributes
Attributes
Reference structures
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 29 of 79
The Create method creates a new Transfer InfoSource for transaction data.
InfoSources created with this method are always flagged as customer-specific. This
method is implemented in function module BAPI_ISOURCE_TD_T_CREATE.
Import parameters InfoSource InfoSource name SourceSystem Source system name FullUpdate Flag: The InfoSource supports the transmission of complete
datasets DeltaUpdate Flag: The InfoSource supports the transmission of dates of
update/change Reloadable Flag: The InfoSource supports the retransmission of data requests Export parameters Return Standard BAPI result parameters Tables TranStructureFields Field definitions for the transfer structure (structure BAPI6100FL)
The Change method changes the transfer InfoSource for transaction data to a source
system. This method is implemented in function module
BAPI_ISOURCE_TD_T_CHANGE.
Import parameters InfoSource InfoSource name SourceSystem Source system name FullUpdate Flag: The InfoSource supports the transmission of complete
datasets DeltaUpdate Flag: The InfoSource supports the transmission of dates of
update/change Export parameters Return Standard BAPI result parameters Tables TranStructureFields (Changed) Field definitions for the transfer structure (structure
BAPI6100FL) TranStructureFieldsX Change flags for the transfer structure (structure BAPI6100FLX)
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 parameters
The ExistenceCheck method checks the existence of a Transfer InfoSource. This
method is implemented in function module BAPI_ISOURCE_TD_T_EXISTS.
Methods
Create
Change
Activate
ExistenceCheck
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 30 of 79
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters Return Standard BAPI result parameters
The GetStatus method delivers the status of the transfer structure. This method is
implemented in function module BAPI_ISOURCE_TD_T_GETSTATUS.
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters TranStructure Name of the transfer structure
Active Flag: InfoSource is active Return Standard BAPI result parameters
The GetDetail method delivers detailed information about the Transfer InfoSource.
This method is implemented in function module
BAPI_ISOURCE_TD_T_GETDETAIL.
The list of the fields of the InfoSource or the transfer structure are sorted by position
numbers.
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters TextShort InfoSource short text (in logon language) TextMedium Medium length text for the InfoSource (in logon language) TextLong InfoSource long text (in logon language) CustomerDefined Flag: InfoSource is defined by the customer FullUpdate Flag: The InfoSource supports the transmission of complete
datasets DeltaUpdate Flag: The InfoSource supports the transmission of dates of
update/change Reloadable Flag: The InfoSource supports the retransmission of data requests TranStructure Name of the transfer structure Active Flag: InfoSource is active ModificationDate Modification date of the transfer structure ModificationTime Modification time of the traansfer structure Return Standard BAPI result parameters Tables Fields Available fields in the InfoSource (structure BAPI6100FL) TranStructureFields Fields of the transfer structure. Only filled if the transfer structure
is active (structure BAPI6100FL).
The GetList method delivers the selection criteria according to the Transfer
InfoSource (with describing texts). This method is implemented in function module
BAPI_ISOURCE_TD_T_GETLIST.
The lists of TransferInfoSources is sorted by source system and InfoSource names.
GetStatus
GetDetail
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 31 of 79
Import parameters SystemType Type of the source system Export parameters Return Standard BAPI result parameters Tables SelInfoSource Selection criteria for the name of the InfoSource (structure
BAPI6102SL) SelTextLong Selection criteria for the long text description of the InfoSource
(structure BAPI6100SL) SelSourceSystem Selection criteria for the name of the source system (structure
BAPI6101SL) InfoSourceList Table of the Transfer InfoSources (according to selection
conditions, structure BAPI6106L)
The SendData method sends data for the InfoSource to the SAP Business
Information Warehouse. Since SAP Business Information Warehouse Release 3.0
the transfer method PSA is used as default to pass the data on to the update rules.
This is the recommend way to transfer transactional data. The transfer method IDOC
is still supported but has been obsolete since then.
The SAP Business Information Warehouse provides complete monitoring
capabilities within the Administration Workbench about the loaded data.
If you send long data records then each record has to be divided into fragments of
exactly 250 bytes using the continuation flag in structure BAPI6100DA. This is due
to a limitation in the BAPI framework. The continuation flag signals that the
fragment for which it is set is the continuation of the fragment that was sent before.
With every call of the SendData method you can send as many records as you like.
You could customize in the SAP Business Information Warehouse a default size for
data package or define the package size on DataSource level.
This size is provided by parameter PackageSize of method RequestInfoSourceData
of the Interface RemoteInfoSourceProvider (IF6107) which is described later. We
do recommend to use this number of records for creating the data packages (relevant
for certification). If this parameter is not used we do recommend to send data
packages with 10.000 to 100.000 records.
Parallel sending of data packages to achieve a better loading performance is
supported.
This method is implemented in function module BAPI_ISOURCE_TD_T_SEND.
Please note: The SendData method has limitations by sending data from a non-
unicode to a unicode system. Use in this case the SendDataBinary method.
SendData
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 32 of 79
Import parameters RequestID Valid request number (see Business Object DataProvider) PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records in the format of the transfer structure
(max. 250 Bytes per data record, continuation records allowed, structure BAPI6100DA)
The SendDataBinary method sends data for the InfoSource to the SAP Business
Information Warehouse. This method has nearly the same functionality as the
SendData method. The only difference is the format of the table ‘Data’. In this case
the data has to be transferred with a binary data format instead of characters. This
method shall be used in case of a data transfer from a non-unicode SourceSystem to
a unicode BW system.
This method is implemented in function module
BAPI_ISOURCE_TD_T_SEND_BIN.
Import parameters RequestID Valid request number (see Business Object DataProvider) PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records in the format of the transfer structure
(max. 250 Bytes per data record, continuation records allowed, structure BAPI6100DARAW)
SendDataBinary
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 33 of 79
The Business Object InfoSourceMaster encapsulates those attributes and methods of
an InfoSource for master data which are independent from an assignment to a source
system. Master data InfoSources are always based on InfoObjects that have already
been defined in the SAP Business Information Warehouse.
The Business Object offers methods for creating and changing InfoSources, for
retrieving detail and status information, as well as retrieving lists of existing
InfoSources.
Just as in the Administrator Workbench, it is not possible to directly change field
information. Changes to field information are always performed by changing the
Transfer InfoSources (see Business Object InfoSourceMasterXfer).
• InfoSource The technical InfoSource name • TextShort InfoSource short text (in logon language) • TextMedium Medium length text for the InfoSource (in logon
language) • TextLong InfoSource long text (in logon language) • CustomerDefined Flag: InfoSource is defined by the customer • Active Flag: InfoSource is active • ComStructure Name of the communication structure • ModificationDate Modification date of the communication structure • ModificationTime Modification time of the communication structure • ComStructureFields Fields of the communication structure (Only used for
the transfer of attributes, not for texts and hierarchies) • AttributeFields Attributes of the InfoSource
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6103 Detailed InfoSource information • BAPI6103L List of InfoSources including text information • BAPI6103SL Selection criteria for InfoSource names • BAPI6100SL Selection criteria for InfoSource long text descriptions • BAPI6100FL Detailed field information (ComStructureFields) • BAPI6100FLS InfoObject list (AttributeFields)
The Create method creates a new InfoSource for master data. InfoSource created by
this method are always considered as customer-specific. This method is implemented
in function module BAPI_ISOURCE_MD_CREATE.
InfoSourceMaster
Key attributes
Attributes
Reference structures
Methods
Create
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 34 of 79
Import parameters InfoObject Name of the InfoObject, to which this InfoSource refers TextShort Short text description
TextMedium Medium-length text description (optional, if not entered then short text is used)
TextLong Long text description (optional, if not entered then short text is used)
Export parameters InfoSource InfoSource name Return Standard BAPI result parameters
The Change method changes the attributes for the InfoSource for master data. This
method is implemented in function module BAPI_ISOURCE_MD_CHANGE.
Import parameters InfoSource InfoSource name TextShort Short text description TextMedium Medium-length text description
(optional, if not entered then short text is used) TextLong Long text description
(optional, if not entered then short text is used) Export parameters Return Standard BAPI result parameters
The ExistenceCheck method checks the existence of an InfoSource. This method is
implemented in function module BAPI_ISOURCE_MD_EXISTS.
Import parameters InfoSource InfoSource name Export parameters Return Standard BAPI result parameters
The GetStatus method delivers the status of the communication structure. This
method is implemented in function module BAPI_ISOURCE_MD_GETSTATUS.
Import parameters InfoSource InfoSource name Export parameters ComStructure Name of the communication structure Active Flag: InfoSource is active Return Standard BAPI result parameters
The GetDetail method delivers detailed information about the InfoSource. This
method is implemented in function module BAPI_ISOURCE_MD_GETDETAIL.
The list of the fields of the InfoSource or the communication structure is sorted by
position numbers.
Import parameters InfoSource InfoSource name
Change
ExistenceCheck
GetStatus
GetDetail
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 35 of 79
Export parameters TextShort InfoSource short text (in logon language) TextMedium Medium length text for the InfoSource (in logon language) TextLong InfoSource long text (in logon language) CustomerDefined Flag: InfoSource is defined by the customer ComStructure Name of the communication structure Active Flag: InfoSource is active ModificationDate Modification date of the communication structure ModificationTime Modification time of the communication structure Return Standard BAPI result parameters Tables AttributeFields Attributes of the InfoSource (structure BAPI6100FLS) ComStructureFields Fields of the communication structure. Only filled if the
communication structure is active (structure BAPI6100FL)
The GetList method delivers the selection criteria according to the InfoSources (with
describing texts). This method is implemented in function module
BAPI_ISOURCE_MD_GETLIST. The list of the InfoSources is sorted by InfoSource
names.
Export parameters Return Standard BAPI result parameters Tables SelInfoSource Selection criteria for the name of the InfoSource (structure
BAPI6103SL) SelTextLong Selection criteria for the long text description of the InfoSource
(structure BAPI6100SL) InfoSourceList Table of the InfoSources (according to selection conditions,
structure BAPI6103L)
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 36 of 79
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 Business Object provides methods for creating and changing Transfer
InfoSources, for retrieving detail and status information, retrieving lists of existing
TransferInfoSources as well as for the transmission of data for the InfoSource to the
SAP Business Information Warehouse in conjunction with the Business Object
DataProvider.
The Business Object InfoSourceHirchyXfer is available for hierarchies for master
data. You can find further details in the description of this Business Object. Unlike
the transfer structure for attributes, the transfer structure for text cannot be changed.
This structure is determined from the properties of the underlying InfoObjects.
• InfoSource The technical InfoSource name • Source System The name of a source system from which the
InfoSource is filled
• TextShort InfoSource short text (in logon language) • TextMedium Medium length text for the InfoSource (in logon
language) • TextLong InfoSource long text (in logon language) • Attributes Flag: The InfoSource delivers attributes • Texts Flag: The InfoSource delivers texts • Hierarchies Flag: The InfoSource delivers hierarchies • TimeDependent Flag: The InfoSource delivers time dependent data • CustomerDefined Flag: InfoSource is defined by the customer • DeltaUpdate Flag: The InfoSource supports the transmission of
updated data for attributes • Reloadable Flag: The InfoSource supports the retransmission of
data requests for attributes • DeltaUpdateText Flag: The InfoSource supports the transmission of
updated data for texts • ReloadableText Flag: The InfoSource supports the retransmission of
data requests for texts • Active Flag: InfoSource is active • TranStructure Name of the transfer structure for attributes (the
transfer structures for texts and hierarchies are not explicitly named)
• ModificationDate Modification date of the transfer structure • ModificationTime Modification time of the transfer structure • TranStructureFields Fields of the transfer structure for attributes
InfoSourceMasterXfer
Key attributes
Attribute
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 37 of 79
• TranStructureFieldsX Change flags for field definitions of the transfer structure for attributes (according to BAPI conventions)
• TransStructureFldTxt Fields of the transfer structure for texts
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6104 detailed InfoSource information • BAPI6104L list of InfoSources including text information • BAPI6103SL selection criteria for InfoSource names • BAPI6100SL selection criteria for InfoSource long text descriptions • BAPI6102SL selection criteria for source systems • BAPI6100FL detailed field information (TranStructureFields) • BAPI6100FLX change flags for fields (TranStructureFieldsX) • BAPI6100DA Data records • BAPI6107DP data request details
The Create method creates a new Transfer InfoSource for master data. In this way,
created InfoSources are always indicated as customer-specific. This method is
implemented in function module BAPI_ISOURCE_MD_T_CREATE.
Import parameters InfoSource InfoSource name SourceSystem Source system name Attributes Flag: The InfoSource delivers attributes Texts Flag: The InfoSource delivers texts Hierarchies Flag: The InfoSource delivers hierarchies TimeDependent Flag: The InfoSource delivers time dependent data DeltaUpdate Flag: The InfoSource supports the transmission of updated data for
attributes Reloadable Flag: The InfoSource supports the retransmission of data requests
for attributes DeltaUpdateText Flag: The InfoSource supports the transmission of updated data for
texts ReloadableText Flag: The InfoSource supports the retransmission of data requests
for texts Tables TranStructureFields Field definitions for the transfer structure (structure BAPI6100FL) Export parameters Return Standard BAPI result parameters
The Change method changes the Transfer InfoSource for master data in a source
system. This method is implemented in function module
BAPI_ISOURCE_MD_T_CHANGE.
The transfer structures for texts cannot be changed (only implicitly via changes to the
underlying InfoObjects).
Reference structures
Methods
Create
Change
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 38 of 79
Import parameters InfoSource InfoSource name SourceSystem Source system name Attributes Flag: The InfoSource delivers attributes Texts Flag: The InfoSource delivers texts Hierarchies Flag: The InfoSource delivers hierarchies TimeDependent Flag: The InfoSource delivers time dependent data DeltaUpdate Flag: The InfoSource supports the transmission of updated data for
attributes Reloadable Flag: The InfoSource supports the retransmission of data requests
for attributes DeltaUpdateText Flag: The InfoSource supports the transmission of updated data for
texts ReloadableText Flag: The InfoSource supports the retransmission of data requests
for texts Export parameters Return Standard BAPI result parameters Tables TranStructureFields (Changed) Field definitions for the transfer structure (structure
BAPI6100FL) TranStructureFieldsX Change indicators for changed fields (see BAPI programmer
guidelines, structure BAPI6100FLX)
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 result parameters
The ExistenceCheck method checks the existence of a Transfer InfoSource. This
method is implemented in function module BAPI_ISOURCE_MD_T_EXISTS.
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters Return Standard BAPI result parameters
The GetStatus method delivers the status of the transfer structure for attributes. This
method is implemented in function module BAPI_ISOURCE_MD_T_GETSTATUS.
Activate
ExistenceCheck
GetStatus
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 39 of 79
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters TranStructure Name of the transfer structure Active Flag: InfoSource is active Return Standard BAPI result parameters
The GetDetail method delivers detailed information on the Transfer InfoSource.
This method is implemented in function module
BAPI_ISOURCE_MD_T_GETDETAIL.
Import parameters InfoSource InfoSource name SourceSystem Source system name Export parameters TextShort InfoSource short text (in logon language) TextMedium Medium length text for the InfoSource (in logon language) TextLong InfoSource long text (in logon language) Attributes Flag: InfoSource delivers master data attributes Texts Flag: InfoSource delivers text for master data Hierarchies Flag: InfoSource delivers hierarchies for master data TimeDependent Flag: The InfoSource delivers time dependent data DeltaUpdate Flag: The InfoSource supports the transmission of updated data for
attributes Reloadable Flag: The InfoSource supports the retransmission of data requests
for attributes DeltaUpdateText Flag: The InfoSource supports the transmission of updated data for
texts ReloadableText Flag: The InfoSource supports the retransmission of data requests
for texts CustomerDefined Flag: InfoSource is defined by the customer TranStructure Name of the transfer structure for attributes Active Flag: InfoSource is active ModificationDate Modification date of the transfer structure ModificationTime Modification time of the transfer structure Return Standard BAPI result parameters Tables AttributeFields Attribute fields of the InfoSource (structure BAPI6100FL) TranStructureFields Fields of the transfer structure for Attribute. Only filled if the
transfer structure is active (structure BAPI6100FL) TranStructureFldTxt Fields of the transfer structure for texts (Always filled, structure
BAPI6100FL)
The GetList method delivers the selection criteria according to Transfer InfoSources
(with describing texts). This method is implemented in function module
BAPI_ISOURCE_MD_T_GETLIST.
The list of TransferInfoSources is sorted by source system and InfoSource names.
GetDetail
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 40 of 79
Import parameters SystemType Type of the source system Export parameters Return Standard BAPI result parameters Tables SelInfoSource Selection criteria for the name of the InfoSource (structure
BAPI6103SL) SelTextLong Selection criteria for the long text description of the InfoSource
(structure BAPI6100SL) SelSourceSystem Selection criteria for the name of the source system (structure
BAPI6101SL) InfoSourceList Table of the Transfer InfoSources (according to selection
conditions, structure BAPI6104L)
The SendData method sends master data for the InfoSource to the SAP Business
Information Warehouse. Since SAP Business Information Warehouse Release 3.0
the transfer method PSA is used as default to pass the data on to the update rules.
This is the recommend way to transfer master data. The transfer method IDOC is still
supported but has been obsolete since then.
The SAP Business Information Warehouse provides complete monitoring
capabilities within the Administration Workbench about the loaded data.
If you send long data records then each record has to be divided into fragments of
exactly 250 bytes using the continuation flag in structure BAPI6100DA. This is due
to a limitation in the BAPI framework. The continuation flag signals that the
fragment for which it is set is the continuation of the fragment that was sent before.
With every call of the SendData method you can send as many records as you like.
You could customize in the SAP Business Information Warehouse a default size for
data package or define the package size on DataSource level.
This size is provided by parameter PackageSize of method RequestInfoSourceData
of the Interface RemoteInfoSourceProvider (IF6107) which is described later. We
do recommend to use this number of records for creating the data packages (relevant
for certification). If this parameter is not used we do recommend to send data
packages with 10.000 to 100.000 records.
Parallel sending of data packages to achieve a better loading performance is
supported.
This method is implemented in function module BAPI_ISOURCE_MD_T_SEND.
Please note: The SendData method has limitations by sending data from a non-
unicode to a unicode system. Use in this case the SendDataBinary method.
SendData
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 41 of 79
Import parameters RequestID Valid request number PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records (max. 250 Bytes long, structure
BAPI6100DA
The SendDataBinary method sends master data for the InfoSource to the SAP
Business Information Warehouse. This method has nearly the same functionality as
the SendData method. The only difference is the format of the table ‘Data’. In this
case the data has to be transferred with a binary data format instead of characters.
This method should be used in case of a data transfer from a non-unicode
SourceSystem to a unicode BW system.
This method is implemented in function module
BAPI_ISOURCE_MD_T_SEND_BIN.
Import parameters RequestID Valid request number PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records (max. 250 Bytes long, structure
BAPI6100DARAW
The SendText method sends texts for the InfoSource to the SAP Business
Information Warehouse. Since SAP Business Information Warehouse Release 3.0
the transfer method PSA is used as default to pass the data on to the update rules.
This is the recommend way to transfer master data. The transfer method IDOC is still
supported but has been obsolete since then.
SendDataBinary
SendText
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 42 of 79
The SAP Business Information Warehouse provides complete monitoring
capabilities within the Administration Workbench about the loaded data.
With every call of the SendData method you can send as many records as you like.
You could customize in the SAP Business Information Warehouse a default size for
data package or define the package size on DataSource level.
This size is provided by parameter PackageSize of method RequestInfoSourceData
of the Interface RemoteInfoSourceProvider (IF6107) which is described later. We
do recommend to use this number of records for creating the data packages (relevant
for certification). If this parameter is not used we do recommend to send data
packages with 10.000 to 100.000 records.
Parallel sending of data packages to achieve a better loading performance is
supported.
This method is implemented in function module
BAPI_ISOURCE_MD_T_SENDTXT.
Please note: The SendData method has limitations by sending data from a non-
unicode to a unicode system. Use in this case the SendDataBinary method.
Import parameters RequestID Valid request number PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records (max. 250 Bytes long, structure
BAPI6100DA)
The SendTextBinary method sends text data for the InfoSource to the SAP Business
Information Warehouse. This method has nearly the same functionality as the
SendText method. The only difference is the format of the table ‘Data’. In this case
the data has to be transferred with a binary data format instead of characters. This
method should be used in case of a data transfer from a non-unicode SourceSystem
to a unicode BW system.
With every call of the SendDataBinary method you can send as many records as you
like. However, we do recommend to send data packets with 10.000 to 100.000
records.
SendTextBinary
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 43 of 79
This method is implemented in function module
BAPI_ISOURCE_MD_T_SENDTXT_BIN.
Import parameters RequestID Valid request number PacketNumber Data packet counter (1st packet should have number 1) LastPacket Flag: The current data packet is the last data packet for the entered
data request. SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Export parameters Return Standard BAPI result parameters Tables Data Table of the data records (max. 250 Bytes long, structure
BAPI6100DARAW)
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 44 of 79
The Business Object InfoSourceHirchyXfer encapsulates the properties of the
hierarchies for a master data InfoSource.
The Business Object provides methods for creating and changing hierarchies, for
displaying detail and status information, for determining the existing hierarchies and
transmitting data for hierarchies to the SAP Business Information Warehouse in
conjunction with the Business Object DataProvider.
Changes to the transfer structure for hierarchies are only possible implicitly by
changing the available hierarchy flags in the InfoObject. The currently valid transfer
structure can be queried using the GetDetail method.
• HierarchyID Hierarchy identification • InfoSource InfoSource name for master data, to which this
hierarchy is assigned • SourceSystem Source system name • HierarchyName Name of the hierarchy • HierarchyVersion Version of the hierarchy (optional) • DateTo End date of the validity of this hierarchy (optional) • DateFrom Start date of the validity of this hierarchy (optional) • TextShort InfoSource short text (in logon language) • TextMedium Medium length text for the InfoSource (in logon
language) • TextLong InfoSource long text (in logon language) • Sorted Flag: Hierarchy node order can be specified • Interval Flag: Hierarchy with interval leaves • TimeDependent Flag: Hierarchy is time-dependent • ModificationDate Modification date of the transfer structure • ModificationTime Modification time of the transfer structure
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6105 detailed hierarchy information • BAPI6105L list of hierarchies • BAPI6105SL selection criteria for hierarchy names • BAPI6100SL selection criteria for hierarchy long text descriptions • BAPI6100DA Data records • BAPI6107DP Data request details
The Create method creates a new hierarchy for a source system. This method is
implemented in function module BAPI_ISOURCE_HI_T_CREATE.
Import parameters InfoSource InfoSource name SourceSystem Source system name HierarchyName Hierarchy name HierarchyVersion Hierarchy version
InfoSourceHirchyXfer
Key attributes
Attributes
Reference structures
Methods
Create
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 45 of 79
DateTo End date for the validity of this hierarchy DateFrom Start date of the validity of this hierarchy TextShort Short text description TextMedium Medium-length text description
(optional, if not entered then short text is used) TextLong Long text description
(optional, if not entered then short text is used) Sorted Hierarchy nodes are sorted Interval Hierarchy with interval leaves TimeDependent Hierarchy is time-dependent Export parameters HierarchyID Hierarchy identification Return Standard BAPI result parameters
The Change method changes a hierarchy for a source system. This method is
implemented in function module BAPI_ISOURCE_HI_T_CHANGE.
Import parameters HierarchyID Hierarchy identification HierarchyName Hierarchy name HierarchyVersion Hierarchy version DateTo End date for the validity of this hierarchy DateFrom Start date of the validity of this hierarchy TextShort (Changed) Short text description TextMedium (Changed) Medium-length text description
(optional, if not entered then short text is used) TextLong (Changed) Long text description
(optional, if not entered then short text is used) Sorted Hierarchy nodes are sorted Interval Hierarchy with interval leaves TimeDependent Hierarchy is time-dependent Export parameters Return Standard BAPI result parameters
The ExistenceCheck method checks the existence of a hierarchy. This method is
implemented in function module BAPI_ISOURCE_HI_T_EXISTS
Import parameters HierarchyID Hierarchy identification Export parameters Return Standard BAPI result parameters
The GetDetail method delivers detailed information on a hierarchy. This method is
implemented in function module BAPI_ISOURCE_HI_T_GETDETAIL.
Import parameters HierarchyID Hierarchy identification Export parameters InfoSource InfoSource name SourceSystem Source system name HierarchyName Hierarchy name HierarchyVersion Hierarchy version DateTo End date for the validity of this hierarchy DateFrom Start date of the validity of this hierarchy
Change
ExistenceCheck
GetDetail
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 46 of 79
TextShort Short text description TextMedium Medium-length text description
(optional, if not entered then short text is used) TextLong Long text description
(optional, if not entered then short text is used) Sorted Hierarchy Hierarchy node order can be specified Interval Hierarchy with interval leaves TimeDependent Hierarchy is time-dependent ModificationDate Modification date of the transfer structure ModificationTime Modification time of the transfer structure Return Standard BAPI result parameters Tables TranStructureFields Field definitions for the transfer structure
The GetList method delivers the selection criteria corresponding to hierarchies to a
source system. This method is implemented in function module
BAPI_ISOURCE_HI_T_GETLIST. The list of the hierarchies is sorted by source
system, InfoSource and hierarchy name, version, date and class.
Import parameters InfoSource InfoSource name SourceSystem Source system name Version Version of the hierarchy ReferenceDate Valid To date of the searched for hierarchy SystemType Type of the source system Export parameters Return Standard BAPI result parameters Tables SelHierarchy Selection criteria for the name of the hierarchy SelTextLong Selection criteria for the long text description for the hierarchy HierarchyList Table of the hierarchies (according to selection conditions )
The SendData method sends hierarchies to the SAP Business Information
Warehouse. Data for hierarchies are sent by creating IDocs and writing them into the
master data hierarchy tables.
Using IDocs (see documentation on the external data interface) provides complete
monitoring capabilities.
The transfer of hierarchy deltas is currently not supported by the SAP Business
Information Warehouse. A hierarchy has always to be transferred completely by a
single call of this method.
In case of the hierarchies you have to send the whole data with one call of the
SendData method..
Please note, that hierarchies sent to the SAP BW are always stored inactive, in order
to avoid unnecessary invalidations of aggregates based on that hierarchy. You will
have to manually activate the hierarchy in the administrator’s workbench to see
reports based on the new hierarchy.
GetList
SendData
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 47 of 79
This method is implemented in function module BAPI_ISOURCE_HI_T_SEND.
Import parameters RequestID Valid request number SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Tables Data Table of the data records (max. 250 Bytes per data record,
continuation records allowed, structure BAPI6100DA)
The SendDataBinary method sends hierachies for the InfoSource to the SAP
Business Information Warehouse. This method has nearly the same functionality as
the SendData method. The only difference is the format of the table ‘Data’. In this
case the data has to be transferred with a binary data format instead of characters.
This method should be used in case of a data transfer from a non-unicode
SourceSystem to a unicode BW system.
This method is implemented in function module
BAPI_ISOURCE_HI_T_SEND_BIN.
Import parameters RequestID Valid request number SelectionDate Date on which the data was selected SelectionTime Time at which the data was selected ExtractionError Extraction error messages provided by the source system
according to standard BAPI result parameters. For available standard error messages please refer to the online documentation.
Tables Data Table of the data records (max. 250 Bytes per data record,
continuation records allowed, structure BAPI6100DARAW)
SendDataBinary
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 48 of 79
The Business Object Interface RemoteInfoSourceProvider 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.
This Business Object provides 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. It also provides methods to retrieve parameters and
help values from the source system to support the selection fields in the scheduler. It
also enables the source system to send error logs to the request monitor in the SAP
Business Information Warehouse on demand.
When creating a data request in the scheduler of the SAP Business Information
Warehouse the scheduler requests those additional parameters, such as USERNAME
and PASSWORD from the end user. Further examples of additional parameters are
the library name and the name of a selection definition in a 3rd Party Tool. The
entered values are transmitted to the source system when sending the data request
(see method SendRequest).
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), BAPI_ISOURCE_DP_GET_HELPVALPAR (for the
method GetParameterHelpValues) and BAPI_ISREQUEST_SEND_LOG. Template
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.
• RequestID Unique ID of the data request • InfoSource InfoSource name for which the data is requested • SourceSystem Source system name from which data is requested • Type Type of requested data (D = transaction data, M =
attributes, T = texts, H = hierarchies) • Date Request date • Time Request time • UserName Name of user making request • UpdateMode Delta, Full, Initial • ParameterDefinition Definition of the application-based parameters • Parameters Values of the application-based parameters • DataSelection Selection criteria for transaction data and master data
attributes • LanguageSelection Selection criteria for languages of the texts on master
data
RemoteInfoSource
Provider
Scenario
Key attributes
Attributes
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 49 of 79
• HierarchySelection Identification of the requested hierarchy
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 • BAPI6107HP parameter help values • BAPI6114MSG messages with severity and next flag
The RequestInfoSourceData 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
BAPI_ISOURCE_DP_REQUEST.
Note: These function module is called from the scheduler in a batch process. After
reveiving the request data on 3rd Party Tool side, the RFC call shall be returned to
SAP system. If the 3rd Party Tool hold this RFC call open until the total process is
finished then a workprocess of the application server in the SAP Business
Information Warehouse is blocked for the whole time.
Import parameters RequestID Unique ID of the data request InfoSource InfoSource name SourceSystem Source system name Type Type of the requested data Date Request date Time Request time UserName Name of user making request UpdateMode Delta, Full, Initial Hierarchy Selection based on a hierarchy request (only necessary for
hierarchy requests, structure BAPI6107HI) PackageSize Expected PackageSize of a package 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)
SelLanguages Selection criteria for texts for master data (Language) (only for requests for texts, structure BAPI6107LA)
Parameters Values of the application-based parameters (only where necessary, structure BAPI6107PA)
The GetParameterDefinition 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.
Reference structures
Methods
RequestInfoSourceData
GetParameterDefinition
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 50 of 79
The method is called during creating of an InfoPackage or when the user pushes the
refresh button in the tap strip ‘3rd selections’.
This method has to be implemented in function module
BAPI_ISOURCE_DP_GETPARDEF of the 3rd Party system
Export parameters Return Standard BAPI return parameter. For available standard error
messages please refer to the online documentation. Tables ParameterDefinition Definition of the application-based parameters (structure
BAPI6107PD)
The GeParametertHelpValues method retrieves a table of help values for parameter
requested by the above GetParameterDefinition method. These fields are displayed
in the BW InfoPackage in the tap strip ‘3rd selections’. The method is called when
the user pushes in the paramater field the F4 button.
This method has to be implemented in function module
BAPI_ISOURCE_DP_GET_HELPVALPAR of the 3rd Party system.
Import parameters Keyname 3rd party tool specific key name 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 SendLog method retrieves a table with messages from the source system. With
the parameter message_type it could be controlled which type(s) of messages are
needed (errors, errors and warning, all). This method has to be implemented in
function module BAPI_ISREQUEST_SEND_LOG of the 3rd Party system.
Import parameters RequestID Unique ID of the data request 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 Parameters Values of the application-based parameters (only where necessary,
structure BAPI6107PA) Messages List of messages occurring during the extraction / sending of data
(structure BAPI6114MSG)
GetParameterHelpValues
SendLog
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 51 of 79
The Business Object SourceSystem encapsulates the logical properties of a source
system. These properties are then always needed if data is to be sent using the IDoc
interface of the SAP Business Information Warehouse rather than using Send
methods of the Business Objects.
• SourceSystem Unique ID of the source system • TextLong Textual description of the source system • Method Activation type for TPCIP connection • Program Program name of the 3rd party sever program
(Complete Path) • GWHost Gateway host name • GWService Gateway service • Host Name of target host • DWSystem Unique ID of the data warehouse system (SAP
Business Information Warehouse, used for the generation of IDocs)
• BasicIdocType Name of the basis IDoc Type of the source system in the SAP Business Information Warehouse
• PortName Name of the port description of the source system in the SAP Business Information Warehouse
• SystemType Type of the source systems (3 = SAP R/3 from 3.0d, B = External system with BAPI, F = External system without BAPI (file interface )).
The reference structures in the ABAP Dictionary for this Business Object are:
• BAPI6101 source system details • BAPI6101L for a list of source systems • BAPI6101SL selection criteria for source system names • BAPI6100SL selection criteria for source system descriptions
The Create method creates a BAPI source system in SAP Business Information
Warehouse This method is implemented in function module
BAPI_SRCSYSTEM_CREATE.
Import parameters SourceSystem Source system name TextLong Textual description of the source system Method Activation Type for TPCIP Connection Program Program name of the 3rd party sever program (Complete Path) GWHost Gateway host name GWService Gateway service Host Name of target host Export parameters Return Standard BAPI result parameters
SourceSystem
Key attributes
Attributes
Reference structures
Methods
Create
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 52 of 79
The ExistenceCheck method checks the existence of a source system. This method is
implemented in function module BAPI_SRCSYSTEM_EXISTS.
Import parameters SourceSystem Source system name Export parameters Return Standard BAPI result parameters
The GetDetail method determines detailed data for a source system. This method is
implemented in function module BAPI_SRCSYSTEM_GETDETAIL.
Import parameters SourceSystem Unique ID of the source system Export parameters TextLong Textual description of the source system DWSystem Unique ID of the receiver system BasicIdocTypee Name of the Basis IDoc Type of the source system PortName Name of the port description of the source system SystemType Type of the source system Method Activation Type for TPCIP Connection Program Program name of the 3rd party sever program (Complete Path) GWHost Gateway host name GWService Gateway service Host Name of target host
The GetList method delivers the source systems that correspond to the selection
criteria. This method is implemented in function module
BAPI_SRCSYSTEM_GETLIST.
The list of the source systems is sorted by names.
Import parameters SystemType Type of the source system Export parameters Return Standard BAPI result parameters Tables SelSourceSystem Selection criteria for the name of the source system (structure
BAPI6101SL) SelTextLong Selection criteria for the long text description of the source system
(structure BAPI6100SL) SourceSystemList Table of the source systems (according to selection conditions,
structure BAPI6101L )
Methods
ExistenceCheck
GetDetail
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 53 of 79
The Business Object InfoObject encapsulates the logical properties of an InfoObject.
These properties are required for the creation of new InfoSources or of fields for
InfoSources. The recreation of and change to InfoObjects is not intended.
• InfoObject Unique name of the InfoObject • Details InfoObject details as described by structures
BAPI6108, BAPI6108AN, BAPI6108AT, BAPI6108CM
The reference structures in ABAP Dictionary for this Business Object are:
• BAPI6108 InfoObject details • BAPI6108CM InfoObject: Compound InfoObjects • BAPI6108AT InfoObject: Attributes • BAPI6108AN InfoObject: Navigationattributes • BAPI6108L list of InfoObjects • BAPI6108SL selection criteria for InfoObject names • BAPI6100SL selection criteria for InfoObject descriptions • 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.
The Change method changes the actual metadata definition of an InfoObject. This
method is implemented in function module BAPI_IOBJ_CHANGE.
The GetDetail method determines detailed data on an InfoObject. This method is
implemented in function module BAPI_IOBJ_GETDETAIL.
InfoObject
Key attributes
Attributes
Reference structures
Methods
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)
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)
GetDetail
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 54 of 79
Import parameters Version Version of the InfoObject (A,M;D) InfoObject ID of the InfoObject Export parameters Details Textual description of the InfoObject Compounds Compound InfoObjects of the InfoObject Attributes Attributes of the InfoObject NavigationAttributes Navigationattributes of the InfoObject Return Standard BAPI result parameters
The GetList method delivers the InfoObjects that correspond to the selection criteria.
This method is implemented in function module BAPI_IOBJ_GETLIST.
The list of the InfoObjects is sorted by names.
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.
GetList
Import parameters Version Version of the InfoObject (A,M;D) Type InfoObjecttype (CHA; KYF; TIM; UNI; DPA) Export parameters Return Standard BAPI result parameters Tables SelInfoObjects Selection criteria for the name of the InfoObject (structure
BAPI6108SL) SelTextLong Selection criteria for the long text description of the InfoObject
(structure BAPI6100SL) InfoObjectList Table of the InfoObjects (according to selection conditions, structure
BAPI6108L)
ActivateMultiple
Import parameters InfoObjects IDs of the InfoObject to be activated (structure BAPI6108IO) Export parameters InfoObjectsError List of InfoObjects that couldn’t be activated Return Standard BAPI return parameter (here as a table)
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 55 of 79
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 • Details InfoObject details as described by structures
BAPI6108, BAPI6108AN, BAPI6108AT, BAPI6108CM
The new reference structures in the ABAP Dictionary for this Business Object is:
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)
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 IDs of the InfoObject to be activated (structure BAPI6108IO) Export parameters InfoObjectsError List of InfoObjects that couldn’t be activated Return Standard BAPI return parameter (here as a table)
InfoObject
Key attributes
Attributes
Reference structures
Methods
Create
Change
ActivateMultiple
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 56 of 79
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.
• InfoCube Unique name of the InfoCube • Details InfoCube details as described by structures
BAPI6112, BAPI6112IO, BAPI6112DI, BAPI6112DIO
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.
Import 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) Export parameters InfoCube ID of the InfoCube Return Standard BAPI return parameter (here as a table)
The Change method changes the actual metadata definition of an InfoCube. This
method is implemented in function module BAPI_CUBE_CHANGE.
InfoCube
Key attributes
Attributes
Reference structures
Methods
Create
Change
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 57 of 79
Import parameters InfoCube ID of the InfoCube 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) Export parameters Return Standard BAPI return parameter (here as a table)
The Activate 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
BAPI_CUBE_ACTIVATE.
Import parameters InfoCube ID of the InfoCube Export parameters Return Standard BAPI return parameter (here as a table)
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
The Business Object InfoObjectCatalog encapsulates the logical properties of an
InfoObjectCatalog. An InfoObjectCatalog is a grouping of InfoObjects according to
Activate
GetList
GetDetail
InfoObjectCatalog
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 58 of 79
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.
• InfoObjCat Unique name of the InfoObjectCatalog • Details InfoObjectCatalog details as described by the structure
BAPI6113
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.
Key attributes
Attributes
Reference structures
Methods
Create
Change
GetList
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 59 of 79
Import parameters Objvers Version of the InfoObjectCatalogs to be selected (A, D, %) IobjTp Type of the InfoObjectCatalogs to be selected (CHA, KYF, %) SelInfoObjCat Selection criteria for the name of the InfoObjectCatalog (structure
BAPI6113SL) SelTextLong Selection criteria for the long text description of the
InfoObjectCatalog (structure BAPI6100SL) Export parameters Return Standard BAPI return parameter InfoObjCatList Table of the InfoObjectCatalogs (according to selection
conditions) with long text descriptions (structure BAPI6113L)
The GetDetail method delivers detailed information on the InfoObjectCatalog. This
method is implemented in function module BAPI_IOBC_GETDETAIL.
Import parameters InfoObjCat ID of the InfoObjectCatalog Objvers Version of the InfoObjectCatalog (A, D) Export parameters Details Properties of the InfoObjectCatalog (structure BAPI6113) InfoObjects InfoObjects of the InfoObjectCatalog (structure BAPI6113IO) Return Standard BAPI return parameter
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.
• RequestID Unique ID of the request
The GetStatus method determines the actual status of an InfoSourceRequest. This
method is implemented in function module BAPI_ISREQUEST_GETSTATUS.
Import parameters RequestID ID of the request Export parameters TechStatus Technical status of the request (G, Y, R) TechInfo Information to the technical status (plain text) QualStatus Manual set status of the request (G, Y, R, initial) QualInfo Information to the manual set status (plain text) Return Standard BAPI return parameter (here as a table)
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.
• InfoPackage Unique name of the InfoPackage
GetDetail
InfoSourceRequest
Key attributes
Methods
GetStatus
InfoPackage
Key attributes
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 60 of 79
• Details InfoPackage details as described by the structure BAPI6109
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 • 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.
Attributes
Reference structures
Methods
Create
CreateFromReference
Change
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 61 of 79
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
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 Status of the scheduled job SelInfoSource Selection criteria for the InfoSources (structure BAPI6102SL) SelDataSource Selection criteria for the DataSources (structure BAPI6109DSSL) SelSourceSystem Selection criteria for the SourceSystems (structure BAPI6101SL) SelTextLong Selection criteria for the long text description of the InfoPackages
(structure BAPI6100SL) Export parameters Return Standard BAPI return parameter InfoPackageList Table of the InfoPackages (according to selection conditions) with
long text descriptions (structure BAPI6109L)
The GetDetail method delivers detailed information for an InfoPackage. This
method is implemented in function module BAPI_IPAK_GETDETAIL.
Import parameters InfoPackage ID of the InfoPackage Export 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) Return Standard BAPI return parameter
The Schedule method gives the possibility to schedule an InfoPackage with the
previously defined parameters. This method is implemented in function module
BAPI_IPAK_START.
GetList
GetDetail
Schedule
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 62 of 79
Import parameters InfoPackage ID of the InfoPackage Export parameters RequestID ID of the generated request Return Standard BAPI return parameter (here as a table)
The CancelSchedule method gives the possibility to abort an already scheduled
loading process that is not yet started. This method is implemented in function
module BAPI_IPAK_STOP.
Import parameters InfoPackage ID of the InfoPackage Export parameters Return Standard BAPI return parameter
The Business Object DataStore encapsulates the logical properties of a DataStore.
The methods of this Business Object include the creation, change, activation of a
DataStore. Futhermore a list method for existing DataStores and retrieving details is
supported.
It is also a method for extracting the content of the DataStore available.
• ODSObject Unique name of the DataStore • Details ODSObject details as described by structures
BAPI6116, BAPI6116IO, BAPI6116NA, BAPI6116IN, BAPI6116II
The reference structures in ABAP Dictionary for this Business Object are:
• BAPI6116 Details of a DataStore • BAPI6116IO InfoObjects of a DataStore • BAPI6116NA Navigation Attributes of a DataStore • BAPI6116IN Indexes for a DataStore • BAPI6116II DataStore InfoObjects in Indexes • BAPI6116L List of DataStore • BAPI6116SL Selection criterias for DataStores • BAPI6100SL Textual selection criterias
The Create method gives the possibility to create a new DataStore. This method is
implemented in function module BAPI_ODSO_CREATE.
Import parameters Details Properties of the DataStore (structure BAPI6116) InfoObjects InfoObjects of the InfoCube (structure BAPI6116IO) NavigationAttributs Navigation Attributes of the DataStore (structure BAPI6112NA) Indexes Indexes (structure BAPI6116IN) IndexesInfoObjects InfoObjects in Indexes (structure BAPI6116II) Export parameters ODSobject ID of the DataStore Return Standard BAPI return parameter (here as a table)
CancelSchedule
DataStore (ODS Object)
Key attributes
Attributes
Reference structures
Methods
Create
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 63 of 79
The Change method changes the actual metadata definition of a DataStore. This
method is implemented in function module BAPI_ODSO_CHANGE.
Import parameters Details Properties of the DataStore (structure BAPI6116) InfoObjects InfoObjects of the InfoCube (structure BAPI6116IO) NavigationAttributs Navigation Attributes of the DataStore (structure BAPI6112NA) Indexes Indexes (structure BAPI6116IN) IndexesInfoObjects InfoObjects in Indexes (structure BAPI6116II) Export parameters ODSobject ID of the DataStore Return Standard BAPI return parameter (here as a table)
The Activate method activates a DataStore. Only consistent DataStores 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
BAPI_ODSO_ACTIVATE.
Import parameters ODSObject ID of the DataStore Export parameters Return Standard BAPI return parameter (here as a table)
The GetList method delivers DataStores according to the selection criteria (with
describing texts). This method is implemented in function module
BAPI_ODSO_GETLIST. The list of the DataStores is sorted by DataStore.
Import parameters Objvers Version of the DataStore to be selected (A, M, D, %) SelODSObject Selection criteria for the name of the DataStore (structure
BAPI6116SL) SelTextLong Selection criteria for the long text description of the DataStore
(structure BAPI6100SL) Export parameters Return Standard BAPI return parameter ODSObjectList Table of the DataStores (according to selection conditions) with
long text descriptions (structure BAPI6116L)
The GetDetail method delivers detailed information on the DataStore. This method
is implemented in function module BAPI_ODSO_GETDETAIL.
Change
Activate
GetList
GetDetail
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 64 of 79
Import parameters ODSObject ID of the DataStoreCube Objvers Version of the DataStore (A, M, D) Export parameters Details Properties of the DataStore (structure BAPI6116) InfoObjects InfoObjects of the DataStore (structure BAPI6116IO) NavigationAttributs Navigation Attributes of the DataStore (structure BAPI6112NA) Indexes Indexes (structure BAPI6116IN) IndexesInfoObjects InfoObjects in Indexes (structure BAPI6116II) Return Standard BAPI return parameter
The ReadDataUc method retrieves the content of a DataStore according to selection
criteria. This method is implemented in function module
BAPI_ODSO_READ_DATA_UC.
Import parameters ODSObject ID of the DataStore SelectAllInfoObjects Read all InfoObjects of a DataStore MaxRows Maximum Number of Lines of Hits CodePage Code Page of Initiator UniCode Is Initiator Unicode-Enabled? Export parameters Details Properties of the DataStore (structure BAPI6116) InfoObjects InfoObjects of the DataStore (structure BAPI6116IO) NavigationAttributs Navigation Attributes of the DataStore (structure BAPI6116NA) Indexes Indexes (structure BAPI6116IN) IndexesInfoObjects InfoObjects in Indexes (structure BAPI6116II) Return Standard BAPI return parameter
Refer to online documentation of function module BAPI_ODS_READ_DATA_UC
for further details about the parameters and usage of it.
ReadDataUc
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 65 of 79
This section contains a technical description of the ABAP Dictionary structures used
and their components. 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.
The Dictionary structure BAPI6100DA is used for sending data to the SAP Business
Information Warehouse Server. Due to limitations in the BAPI interface, data
records have to be fragmented into pieces of 250 bytes. Continuation records are
identified by the continuation flag.
Field name Type Length Description CONTINUATION CHAR 1 Flag: Continuation record DATA CHAR 250 Data record
The Dictionary structure BAPI6100DARAW is used for sending data to the SAP
Business Information Warehouse Server in a binary format. Due to limitations in the
BAPI interface, data records have to be fragmented into pieces of 250 bytes.
Continuation records are identified by the continuation flag.
Field name Type Length Description CONTINUATION CHAR 1 Flag: Continuation record DATA RAW 250 Data record
The dictionary structure BAPI6100FL is used for detailed field descriptions in
transfer structures.
Field name Type Length Description POSITION NUMC 4 Field position in the transfer structure TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description MANDATORY CHAR 1 Flag: Field is mandatory SELECTABLE CHAR 1 Flag: Field may be used in selection
criteria INFOOBJECT CHAR 30 Name of the corresponding InfoObject FIELDNM CHAR 30 Field name to be used DTELNM CHAR 30 Name of the corresponding data element DATATYPE CHAR 4 Dictionary data type (CHAR, QUAN, …) INTLEN NUMC 6 Internal length in bytes LENG NUMC 6 Field length (# of characters) INTTYPE CHAR 1 ABAP data type (C, N, P, …) CONVEXIT CHAR 5 Name of the conversion exit DECIMALS NUMC 6 Number of decimals UNIFIELDNM CHAR 30 Name of the corresponding unit field
The dictionary structure BAPI6100FLS is used for short field descriptions in
communication structures.
ABAP Dictionary Structures
BAPI6100DA
BAPI6100DARAW
BAPI6100FL
BAPI6100FLS
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 66 of 79
Field name Type Length Description INFOOBJECT CHAR 30 Name of the corresponding InfoObject
The dictionary structure BAPI6100FLX is used to identify changes in field definition
for transfer structures.
Field name Type Length Description POSITION CHAR 1 Flag: Position has changed MANDATORY CHAR 1 Flag: Mandatory flag has changed SELECTABLE CHAR 1 Flag: Selectable flag has changed INFOOBJECT CHAR 1 Flag: InfoObject name has changed FIELDNM CHAR 1 Flag: Field name has changed DATATYPE CHAR 1 Flag: Data type has changed LENG CHAR 1 Flag: Length has changed CONVEXIT CHAR 1 Flag: Conversion exit has changed UNIFIELDNM CHAR 1 Flag: Unit field name has changed
The dictionary structure BAPI6100SL is used for the specification of selection
criteria for long text descriptions.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) TEXTLONGLOW CHAR 60 Description (lower bound) TEXTLONGHIGH CHAR 60 Description (upper bound)
The dictionary structure BAPI6101 describes a source system.
Field name Type Length Description SOURCESYSTEM CHAR 10 The technical name of a source system DESCRIPTION CHAR 40 Description of the source system DWSYSTEM CHAR 10 Technical name of the data warehouse
system BASICIDOCTYPE CHAR 30 Name of the basic IDoc type PORTNAME CHAR 10 Name of the ALE port SYSTEMTYPE CHAR 1 Type of the source system
The dictionary structure BAPI6101L is used to provide a list of source systems.
Field name Type Length Description SOURCESYSTEM CHAR 10 The technical name of a source system SYSTEMTYPE CHAR 1 Type of the source system DESCRIPTION CHAR 40 Description of the source system
The dictionary structure BAPI6101SL is used for the specification of selection
criteria for source systems.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) SOURCESYSTEMLOW CHAR 10 Source system name (lower bound) SOURCESYSTEMHIGH CHAR 10 Source system name (upper bound)
BAPI6100FLX
BAPI6100SL
BAPI6101
BAPI6101L
BAPI6101SL
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 67 of 79
The dictionary structure BAPI6102 is used for details about transaction data
InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description CUSTOMERDEFINED CHAR 1 Flag: InfoSource is defined by the
customer ACTIVE CHAR 1 Flag: InfoSource is active (data
transmission is possible) COMSTRUCTURE CHAR 30 Name of the communication structure MODIFICATIONDATE DATS 8 Modification date of communication
structure MODIFICATIONTIME TIMS 6 Modification time of communication
structure
The dictionary structure BAPI6102L is used for lists of transaction data InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description
The dictionary structure BAPI6102SL is used for the specification of selection
criteria for transaction data InfoSources.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) INFOSOURCELOW CHAR 30 InfoSource (lower bound) INFOSOURCEHIGH CHAR 30 InfoSource (upper bound)
The dictionary structure BAPI6103 is used for details about master data InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description MSDFLAG CHAR 1 Flag: InfoSource provides master data
attributes TXTFLAG CHAR 1 Flag: InfoSource supports text information HIEFLAG CHAR 1 Flag: InfoSource supports hierarchies CUSTOMERDEFINED CHAR 1 Flag: InfoSource is defined by the
customer ACTIVE CHAR 1 Flag: InfoSource is active (data
transmission is possible) COMSTRUCTURE CHAR 30 Name of the communication structure MODIFICATIONDATE DATS 8 Modification date of communication
structure
BAPI6102
BAPI6102L
BAPI6102SL
BAPI6103
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 68 of 79
MODIFICATIONTIME TIMS 6 Modification time of communication structure
The dictionary structure BAPI6103L is used for lists of master data InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description
The dictionary structure BAPI6103SL is used for the specification of selection
criteria for master data InfoSource.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) INFOSOURCELOW CHAR 30 InfoSource (lower bound) INFOSOURCEHIGH CHAR 30 InfoSource (upper bound)
The dictionary structure BAPI6104 is used for details about master data transfer
InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description MSDFLAG CHAR 1 Flag: InfoSource provides master data
attributes TXTFLAG CHAR 1 Flag: InfoSource supports text information HIEFLAG CHAR 1 Flag: InfoSource supports hierarchies TIMDEPFL CHAR 1 Flag: InfoSource supports time dependent
attributes DELTAUPD CHAR 1 Flag: InfoSource supports delta updates PACKGUPD CHAR 1 Flag: InfoSource supports reloading data
requests CUSTOMERDEFINED CHAR 1 Flag: InfoSource is defined by the
customer ACTIVE CHAR 1 Flag: InfoSource is active (data
transmission is possible) TRANSTRUCTURE CHAR 27 Name of the transfer structure MODIFICATIONDATE DATS 8 Modification date of transfer structure MODIFICATIONTIME TIMS 6 Modification time of transfer structure
The dictionary structure BAPI6104L is used for lists of master data transfer
InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description
BAPI6103L
BAPI6103SL
BAPI6104
BAPI6104L
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 69 of 79
TEXTLONG CHAR 60 Long description
The dictionary structure BAPI6105 is used for details about hierarchies.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system HIERARCHYID CHAR 30 Hierarchy ID NAME CHAR 30 Name of the hierarchy VERSION CHAR 3 Version of the hierarchy DATETO DATS 8 Date valid until DATEFROM DATS 8 Date valid from TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description SORTED CHAR 1 Flag: Hierarchy contains sorted nodes INTERVAL CHAR 1 Flag: Hierarchy contains intervals TIMEDEPENDENT CHAR 1 Flag: Hierarchy nodes are time dependent
The dictionary structure BAPI6105L is used for lists of hierarchies.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system HIERARCHYID CHAR 30 Hierarchy ID NAME CHAR 30 Name of the hierarchy VERSION CHAR 3 Version of the hierarchy DATETO DATS 8 Date valid until DATEFROM DATS 8 Date valid from TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description
The dictionary structure BAPI6105SL is used for the specification of selection
criteria for master data InfoSource.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 1 Selection operator (see ranges tables) HIERARCHYLOW CHAR 30 Hierarchy name (lower bound) HIERARCHYHIGH CHAR 30 Hierarchy name (upper bound)
The dictionary structure BAPI6106 is used for details about transaction data transfer
InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description FULLUPD CHAR 1 Flag: InfoSource supports full updates DELTAUPD CHAR 1 Flag: InfoSource supports delta updates STOCKUPD CHAR 1 Flag: InfoSource supports stock updates
BAPI6105
BAPI6105L
BAPI6105SL
BAPI6106
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 70 of 79
PACKGUPD CHAR 1 Flag: InfoSource supports package updates
DELTINIT CHAR 1 Flag: InfoSource supports delta updates CUSTOMERDEFINED CHAR 1 Flag: InfoSource is defined by the
customer ACTIVE CHAR 1 Flag: InfoSource is active (data
transmission is possible) TRANSTRUCTURE CHAR 30 Name of the transfer structure MODIFICATIONDATE DATS 8 Modification date of transfer structure MODIFICATIONTIME TIMS 6 Modification time of transfer structure
The dictionary structure BAPI6106L is used for lists of transaction data InfoSources.
Field name Type Length Description INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system TEXTSHORT CHAR 20 Short description TEXTMEDIUM CHAR 40 Medium length description TEXTLONG CHAR 60 Long description
The dictionary structure BAPI6107DA is used for the specification of selection
criteria for data requests.
Field name Type Length Description INFOOBJECT CHAR 30 Name of the selection field SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) LOW CHAR 45 Field value (lower bound) HIGH CHAR 45 Field value (upper bound)
The dictionary structure BAPI6107DP is used for general data request parameters.
Field name Type Length Description REQUEST CHAR 30 Request number PACKETNUMBER NUMC 6 Current data packet number LASTPACKET CHAR 1 Flag: Current packet is the last data packet SELECTIONDATE DATS 8 Selection date SELECTIONTIME TIMS 6 Selection time
The dictionary structure BAPI6107DR is used for data request details.
Field name Type Length Description REQUEST CHAR 30 Request number INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system REQUESTTYPE CHAR 1 Type of requested data REQUESTDATE DATS 8 Request date REQUESTTIME TIMS 6 Request time REQUESTUSER CHAR 12 User name of the requesting user UPDATEMODE CHAR 1 Requested update mode
The dictionary structure BAPI6107DR is used for data request details.
Field name Type Length Description REQUEST CHAR 30 Request number
BAPI6106L
BAPI6107DA
BAPI6107DP
BAPI6107DR
BAPI6107DR
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 71 of 79
INFOSOURCE CHAR 30 Name of the InfoSource SOURCESYSTEM CHAR 10 Name of the source system REQUESTTYPE CHAR 1 Type of requested data REQUESTDATE DATS 8 Request date REQUESTTIME TIMS 6 Request time REQUESTUSER CHAR 12 User name of the requesting user UPDATEMODE CHAR 2 Requested update mode REQUESTSTATUS CHAR 1 Status of the request REQUESTINFO CHAR 120 Plain text to the request status
The dictionary structure BAPI6107HI is used for hierarchy selection in data requests.
Field name Type Length Description NAME CHAR 30 Hierarchy name VERSION CHAR 3 Hierarchy version DATETO DATS 8 Date valid until
The dictionary structure BAPI6107LA is used for language selection in data requests.
Field name Type Length Description LANGU CHAR 1 Selected language
The dictionary structure BAPI6107PA is used to transmit 3rd party specific
parameters of a data request.
Field name Type Length Description KEYNAME CHAR 30 3rd party tool specific key name KEYVALUE CHAR 128 3rd-party-specific key value
The dictionary structure BAPI6107PD is used to transmit the definition of 3rd party
specific parameters to the SAP Business Information Warehouse.
Field name Type Length Description KEYNAME CHAR 30 3rd party tool specific key name TEXTLONG CHAR 60 Description of the parameter DATATYPE CHAR 4 Data type (CHAR or NUMC) MAXLENGTH NUMC 6 Maximum length of the parameter value MANDATORY CHAR 1 Flag: Parameter is mandatory PASSWORD CHAR 1 Flag: Parameter is a password (Value is
not displayed in dialogs)
The dictionary structure BAPI6107HP is used to transmit the help values for 3rd
party specific parameters to the SAP Business Information Warehouse.
Field name Type Length Description KEYVALUE CHAR 128 3rd-party-specific key value LANGU CHAR 1 Language Key TEXTLG CHAR 60 Long description)
The dictionary structure BAPI6108 is used for details of InfoObjects. A detailed
description of this structure can be found in the ABAP dictionary.
BAPI6107HI
BAPI6107LA
BAPI6107PA
BAPI6107PD
BAPI6107HP
BAPI6108
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 72 of 79
The dictionary structure BAPI6108AN is used for details specific to InfoObjects of
type navigation attribute. A detailed description of this structure can be found in the
ABAP dictionary.
The dictionary structure BAPI6108AN is used for details specific to InfoObjects of
type attributes. A detailed description of this structure can be found in the ABAP
dictionary.
The dictionary structure BAPI6108CM is used for details specific to compound
InfoObjects. A detailed description of this structure can be found in the ABAP
dictionary.
The dictionary structure BAPI6108IO represents a list of InfoObjects.
Field name Type Length Description INFOOBJECT CHAR 30 Name of the InfoObject
The dictionary structure BAPI6108L is used for lists of InfoObjects. A detailed
description of this structure can be found in the ABAP dictionary.
The dictionary structure BAPI6108SL is used for the specification of selection
criteria for InfoObjects.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 1 Selection operator (see ranges tables) INFOOBJECTLOW CHAR 30 Hierarchy name (lower bound) INFOOBJECTHIGH CHAR 30 Hierarchy name (upper bound)
The dictionary structure BAPI6109 represents the details of an InfoPackage.
Field name Type Length Description INFOPACKAGE CHAR 30 ID of the InfoPackage INFOSOURCE CHAR 30 Name of the InfoSource INFOSOURCETYPE CHAR 1 Type of the InfoSource 'I' for Transaction
Data, 'O' for others LOGSYS CHAR 10 Name of the Source System DATASOURCE CHAR 30 Name of the DataSource DATASOURCETYPE CHAR 1 Type of the DataSource; 'D' for
Transaction Data, 'M' for Master Data, 'T' for Texts and 'H' for Hierarchies
UPMODE_READ 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.
HIERACT CHAR 1 Automatic activation of hierarchy CHAVL_CHECK CHAR 1 Check for consistency UPDATEMASTERDATA CHAR 1 '3' means Update only when all
Masterdata exists, '1' means update always which means auto-Sid-generation
TEXT CHAR 60 Description of the InfoPackage LOAD_STATUS CHAR 1 Scheduling status; 'R' for running, 'S' for
BAPI6108AN
BAPI6108AT
BAPI6108CM
BAPI6108IO
BAPI6108L
BAPI6108SL
BAPI6109
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 73 of 79
scheduled, 'F' for finished, 'A' for abend, 'P' for planned, all others are only short-time 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.
The dictionary structure BAPI6109BTCH represents the scheduling parameters of an
InfoPackage.
Field name Type Length Description STARTDTTYP CHAR 1 Type of start date SDLSTRTDT DATS 8 Scheduled execution date SDLSTRTTM TIMS 6 Scheduled execution time 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)
In the dictionary structure BAPI6109DEST it is possible to specify the destination of
the data.
Field name Type Length Description ONLYENTRANCE CHAR 1 Only to PSA or ALE entrance ONLYCUBETAB CHAR 1 Only to InfoCube or table PARALLEL CHAR 1 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).
CUBEAFTERODS CHAR 1 To Cubes after PSA is completed and green (for all datapackages of the request)
In the dictionary structure BAPI6109FILE it is possible to specify the parameters for
a load from a flat file.
Field name Type Length Description LOCATION CHAR 1 Location of the file (client workstation or
application server '0' means data from the appl.server
BAPI6109BTCH
BAPI6109DEST
BAPI6109FILE
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 74 of 79
'1' means data from the client workstation FILENAME CHAR 128 Name of the file FILETYPE CHAR 1 Type of the file (ASCII, CSV)
'1' means Ascii-File '2' means Excel-CSV-Typ
FILESEP RAW 1 Separator for CSV files ESC RAW 1 Escape sign CHAR1000 CHAR 1 Thousand separator DECICHAR CHAR 1 Character for decimal point CURRCONV CHAR 1 Currency conversion from external to
internal format
In the dictionary structure BAPI6109HIE it is possible to specify the hierarchy to be
loaded.
Field name Type Length Description HIENM CHAR 30 Name of the hierarchy HIEVERS CHAR 3 Version of the hierarchy HIEDATETO DATS 8 Valid until HIEDATEFROM DATS 8 Valid from HIECLASS CHAR 4 Hierarchy class NEW_HIENAME_ON CHAR 1 New hierarchy name wanted? NEW_HIENM CHAR 30 New name of the hierarchy
In the dictionary structure BAPI6109IC it is possible to specify the InfoCubes that
should be updated during the load process.
Field name Type Length Description INFOCUBE CHAR 30 Name of the InfoCube LOADCUBE CHAR 1 InfoCube should be updated DELETEALLBEFORE CHAR 1 Delete the whole cube content before
loading data to the cube
In the dictionary structure BAPI6109SEL it is possible to specify selection
parameters for the load process.
Field name Type Length Description FIELDNAME CHAR 30 Field name IOBJNM CHAR 30 InfoObject name SIGN CHAR 1 Selection operator (see ranges tables)
(only 'I' useful) OPT CHAR 2 Selection operator (see ranges tables)
(only 'EQ' or 'BT' useful) LOW CHAR 45 Lower bound HIGH CHAR 45 Upper bound
The dictionary structure BAPI6109TCP represents the parameters needed for the
access to the 3rd party system.
Field name Type Length Description RFCFIELDNM CHAR 30 Name of the field to be filled RFCVALUE CHAR 128 Value of the field
BAPI6109HIE
BAPI6109IC
BAPI6109SEL
BAPI6109TCP
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 75 of 79
RFCUSER CHAR 32 User to logon to the 3rd party system PASSWORD CHAR 8 Password to logon to the 3rd party system
The dictionary structure BAPI6112 represents the details of an InfoCube.
Field name Type Length Description INFOCUBE CHAR 30 InfoCube OBJVERS CHAR 1 Objectversion TEXTLONG CHAR 60 Long text OBJSTAT CHAR 3 Objectstatus CONTREL CHAR 6 Content release CONTTIMESTMP DEC 15 Content timestamp OWNER CHAR 12 Owner ACTIVFL CHAR 1 Active and modified version identical BWAPPL CHAR 10 BW application (namespace) INFOAREA CHAR 30 InfoArea NCUMTIM CHAR 30 Ref. time char. for non cumulatives CUBETYPE CHAR 1 InfoCube type BASICCUBE CHAR 30 Basic InfoCube for the aggregate SLOGSYS CHAR 10 Source system PARTTIM CHAR 30 Partitioning time characteristic PARTVL_FROM CHAR 10 Lower limit (partitioning value) PARTVL_TO CHAR 10 Upper limit (partitioning value) PARTMAXCNT INT4 10 Maximum number of partitions DIMESIZCAT CHAR 2 BW: Size category for dimension tables DIMEDATCLS CHAR 5 BW: Data class for dimension tables 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
BAPI6112
BAPI6112IO
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 76 of 79
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
The dictionary structure BAPI6112DIO represents the InfoObjects of a dimension of
an InfoCube.
Field name Type Length Description INFOCUBE CHAR 30 InfoCube OBJVERS CHAR 1 Object version DIMENSION CHAR 30 Dimensionname POSIT NUMC 4 Position of the field in the structure / table INFOOBJECT CHAR 30 Name of the InfoObject ATRNAVFL CHAR 1 The InfoObject is a navigation attribute
The dictionary structure BAPI6112L is used to provide a list of InfoCubes.
Field name Type Length Description INFOCUBE CHAR 30 InfoCube OBJVERS CHAR 1 Object version TEXTLONG CHAR 60 Long description OBJSTAT CHAR 3 Objectstatus ACTIVFL CHAR 1 Active and modified version identical INFOAREA CHAR 30 InfoArea CUBETYPE CHAR 1 InfoCube type
The dictionary structure BAPI6112SL is used for the specification of selection
criteria for InfoCubes.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) INFOCUBELOW CHAR 30 InfoCube (lower bound) INFOCUBEHIGH CHAR 30 InfoCube (upper bound)
The dictionary structure BAPI6113 represents the details of an InfoObjectCatalog.
Field name Type Length Description INFOOBJCAT CHAR 30 InfoObjectCatalog OBJVERS CHAR 1 Objectversion
BAPI6112DI
BAPI6112DIO
BAPI6112L
BAPI6112SL
BAPI6113
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 77 of 79
TEXTLONG CHAR 60 Long description OBJSTAT CHAR 3 Objectstatus CONTREL CHAR 6 Content release CONTTIMESTMP DEC 15 Content timestamp OWNER CHAR 12 Owner BWAPPL CHAR 10 BW application (namespace) IOBJTP CHAR 3 Type of an InfoObject INFOAREA CHAR 30 InfoArea TSTPNM CHAR 12 Last changed by TIMESTMP DEC 15 UTC time stamp in short form
(YYYYMMDDhhmmss)
The dictionary structure BAPI6113IO represents the list of InfoObjects of an
InfoObjectCatalog.
Field name Type Length Description INFOOBJCAT CHAR 30 InfoObjectCatalog OBJVERS CHAR 1 Object version INFOOBJECT CHAR 30 Name of the InfoObject
The dictionary structure BAPI6113L is used to provide a list of InfoObjectCatalogs.
Field name Type Length Description INFOCUBE CHAR 30 InfoCube OBJVERS CHAR 1 Object version TEXTLONG CHAR 60 Long description OBJSTAT CHAR 3 Object status IOBJTP CHAR 3 Type of an InfoObject INFOAREA CHAR 30 InfoArea
The dictionary structure BAPI6113SL is used for the specification of selection
criteria for InfoObjectCatalogs.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables) OPTION CHAR 2 Selection operator (see ranges tables) INFOOBJCATLOW CHAR 30 InfoObjectCatalog (lower bound) INFOOBJCATHIGH CHAR 30 InfoObjectCatalog (upper bound)
The dictionary structure BAPI6114MSG is used to transmit messages from the 3rd
party system to the SAP Business Information Warehouse .
Field name Type Length Description TYPE CHAR 1 Message type: S Success, E Error, W
Warning, I Info, A Abort SEQUELFLAG CHAR 1 Flag: Update segment LINE CHAR 255 Text field length 255: texts
The dictionary structure BAPI6108 is used for details of DataStore. A detailed
description of this structure can be found in the ABAP dictionary.
BAPI6113IO
BAPI6113L
BAPI6113SL
BAPI6114MSG
BAPI6116
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 78 of 79
The dictionary structure BAPI6116IO represents the InfoObjects of a DataStore.
Field name Type Length Description ODSOBJECT CHAR 30 ID of the DataStore POSIT CHAR 4 Position of the Field in the Structure /
Table KEYFLAG CHAR 1 Identifies a key field of a table INFOOBJECT CHAR 30 ID of the InfoObject IOBJTP CHAR 3 Type of an InfoObject
The dictionary structure BAPI6116IO represents the Navigation Attributes of a
DataStore.
Field name Type Length Description ODSOBJECT CHAR 30 ID of the DataStore ATRNAVNM CHAR 30 Name of Navigation Attribute (in
Reporting Structure) ATTRINM CHAR 30 ID of Master data attribute CHANM CHAR 30 ID of the Characteristic
The dictionary structure BAPI6116IN represents the Index of a DataStore.
Field name Type Length Description ODSOBJECT CHAR 30 ID of the DataStore INDEXID CHAR 3 Unique Index ID in a Table UNIQUEFLAG CHAR 1 Flag for UNIQUE indexes
The dictionary structure BAPI6116II represents the InfoObjects of an Index of a
DataStore.
Field name Type Length Description ODSOBJECT CHAR 30 ID of the DataStore INDEXID CHAR 3 Unique Index ID in a Table POSIT CHAR 4 Position of the Field in the Structure /
Table INFOOBJECT CHAR 30 ID of the InfoObject
The dictionary structure BAPI6116L is used to provide a list of a DataStores.
Field name Type Length Description ODSOBJECT CHAR 30 ID of the DataStore OBJVERS CHAR 1 Version of the DataStore (A, M, D) TEXTLONG CHAR 60 Long description OBJSTAT CHAR 3 Object Status of the DataStore ACTIVFL CHAR 1 Active and revised version do not agree INFOAREA CHAR 30 InfoArea ODSOTYPE CHAR 1 Type of DataStore
The dictionary structure BAPI6112SL is used for the specification of selection
criteria for DataStores.
Field name Type Length Description SIGN CHAR 1 Selection operator (see ranges tables)
BAPI6116IO
BAPI6116NA
BAPI6116IN and BAPI6116II
BAPI6116L
BAPI6116SL
-
Staging BAPIs
for the
SAP Business Information Warehouse
SAP AG Version 3.5GA – 02.11.2005 Page 79 of 79
OPTION CHAR 2 Selection operator (see ranges tables) ODSOBJECTLOW CHAR 30 DataStore (lower bound) ODSOBJECTHIGH CHAR 30 DataStore (upper bound)
The dictionary structure BAPI6116IOLS represents a list of InfoObjects.
Field name Type Length Description INFOOBJECT CHAR 30 Name of the InfoObject
The dictionary structure BAPI6112SL is used for the specification of selection
criteria for DataStores.
Field name Type Length Description INFOOBJECT CHAR 30 Name of the InfoObject SIGN CHAR 1 Selection criteria: SIGN (see ranges
tables) OPTION CHAR 2 Selection criteria: OPTION (see ranges
tables) LOW CHAR 45 Selection criteria: From value HIGH CHAR 45 Selection criteria: To value
The Dictionary structure BAPI6116DAUC is used for sending data from the SAP
Business Information Warehouse Server to a 3rd party client. Due to limitations in
the BAPI interface, data records are fragmented into pieces of 250 bytes.
Continuation records are identified by the continuation flag.
Field name Type Length Description USABLE INT 4 In field DATA used length in CHAR CONTINUATION CHAR 1 Flag: Continuation record DATA CHAR 250 Data record
The dictionary structure BAPI6116DALO represents the layout of the combined
data record.
Field name Type Length Description INFOOBJECT CHAR 30 Name of the InfoObject TYPE CHAR 1 Internal data type (internal ABAP type) OFFSET NUMC 6 Field offset LENGTH NUMC 6 Field length
BAPI6116IOLS
BAPI6116SLIO
BAPI6116DAUC and
BAPI6116DALO