July 30, 2023

tSAPInfoCubeInput – Docs for ESB 7.x


Retrieves InfoCube data from an SAP BW system.

tSAPInfoCubeInput Standard properties

These properties are used to configure tSAPInfoCubeInput running in the Standard Job framework.

The Standard
tSAPInfoCubeInput component belongs to the Business family.

The component in this framework is available in all subscription-based Talend products.

Basic settings

Property Type

Select the way the connection details
will be set.

  • Built-In: The connection details will be set
    locally for this component. You need to specify the values for all
    related connection properties manually.

  • Repository: The connection details stored
    centrally in Repository > Metadata will be reused by this component. You need to click
    the […] button next to it and in the pop-up
    Repository Content dialog box, select the
    connection details to be reused, and all related connection
    properties will be automatically filled in.

Use an existing connection

Select this check box and from the Connection configuration drop-down list displayed, select the component
in which the relevant reused database connection is configured.

When a Job contains a parent Job and a child Job, the list
displayed presents only the connection components in the same Job level.

Server Type

Select the type of the SAP server to be connected, either
Application Server or Message


The SAP system client ID.

UserId and Password

The user connection ID and password.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.


The language of the SAP system.

Host name

The name or IP address of the host on which the SAP server is

System number

The SAP system number.

This property is available only when Application
is selected from the Server
drop-down list.

System ID

The SAP system ID.

This property is available only when Message
is selected from the Server
drop-down list.

Group Name

The SAP group name.

This property is available only when Message
is selected from the Server
drop-down list.

Schema and Edit schema

A schema is a row description. It defines the number of fields
(columns) to be processed and passed on to the next component. When you create a Spark
Job, avoid the reserved word line when naming the

  • Built-In: You create and store the schema locally for this component

  • Repository: You have already created the schema and stored it in the
    Repository. You can reuse it in various projects and Job designs.

Click Edit
to make changes to the schema.

Note: If you
make changes, the schema automatically becomes built-in.
  • View schema: choose this
    option to view the schema only.

  • Change to built-in property:
    choose this option to change the schema to Built-in for local changes.

  • Update repository connection:
    choose this option to change the schema stored in the repository and decide whether
    to propagate the changes to all the Jobs upon completion. If you just want to
    propagate the changes to the current Job, you can select No upon completion and choose this schema metadata
    again in the Repository Content

component offers the advantage of the dynamic schema feature. This allows you to
retrieve unknown columns from source files or to copy batches of columns from a source
without mapping each column individually. For further information about dynamic schemas,
Talend Studio

User Guide.

dynamic schema feature is designed for the purpose of retrieving unknown columns of a
table and is recommended to be used for this purpose only; it is not recommended for the
use of creating tables.


The name of the InfoCube object from which data will be retrieved.

Max row number

Specify the maximum number of rows to be retrieved. By default,
the value is set to -1, which means all rows will be

Filter Group

Specify the search condition(s) used to filter
data to be retrieved by clicking the [+] button to
add as many rows as needed, each row for a search condition, and set the
value of the following attributes for each condition.

  • Column: enter the name of the schema column
    based on which retrieved data will be filtered.

  • Sign: select either
    Include or Exclude
    from the drop-down list.

    • Include: the data that meets the
      condition will be retrieved.

    • Exclude: the data that doesn’t meet
      the condition will be retrieved.

  • Operator: select from the drop-down list the
    data filter operator used to build the search condition.

  • Value: specify the search value used to build
    the search condition.

  • High value: specify another search value used
    to build the search condition for the between operator.

    When using a column of Date type to specify a filter, the date and
    time values in the Value and High
    columns should be in the format
    yyyyMMdd and
    HHMMSS, which might be different from the
    format defined in the schema editor.

The following wildcard characters can
be used when specifying the search value using pattern:

  • *: match any number of characters.

  • +: match a single character.

  • #: be used to escape characters (e.g. *, #)
    and for exact case sensitive comparison.

Specify a shared destination

Select this check box and specify the shared destination in the
Shared destination name field
displayed. The shared destination allows the SAP components to use the
shared destination on the Talend Runtime when they are executed as part of
an ESB Route or ESB Data Service within the Talend Runtime
container OSGi Environment.

Besides specifying the shared destination name in the component,
you also need to setup the SAP DataSource for the Talend Runtime.
What you need to do to define the SAP DataSource and how to configure it are
described in the readme.txt provided in the Talend ESB
package within the /add-ons/datasource/sap folder.

Note that if you use the component’s own connection configuration,
your SAP connection will be closed at the end of the component. To prevent
this from happening, use a shared destination with its name specified.

Use FTP-Batch Options

Select this check box when the size of data to be retrieved is larger than
the size specified in the Fetch size field. With this
check box selected, the SAP system will generate as many files as needed and
write the retrieved data into these files, and this component will then read
the files via an FTP connection to retrieve data and transfer the retrieved
data to the output component.

The following properties need to be specified when this checkbox is

  • File Protocol: Select FTP or the secure
    alternative SFTP.
  • Host: The IP address or host name of the FTP

  • Port: The listening port number of the FTP

  • User and Password: The
    user authentication data required to access the FTP server.

  • Directory: The directory where the files
    generated by the SAP system will be saved.

  • Data filename prefix: The prefix of the files
    generated by the SAP system.

Advanced settings

Fetch size

Enter the fetch size (in KB) that specifies the amount of
resultset data sent during one single communication step with the SAP BW

SAP Properties

If you need to use custom configuration for the SAP system being
used, complete this table with the property or properties to be customized.
For example,

This property is not visible when the Use an existing
check box is selected.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level
as well as at each component level.

Global Variables


The error message generated by the component when an error occurs. This is an After
variable and it returns a string.


Usage rule

This component is usually used as a start component of a Job or
subJob and it always needs an output link.


Specific jar and dll files provided by SAP must be added to your
Studio and the workstation hosting your Studio. The exact procedure varies
among platforms such as 32-bit or 64-bit Windows or Linux.

  • You can find an example of how to install SAP Java connectors in
    Talend Help Center (https://help.talend.com) and the “Centralizing SAP
    metadata” section in Talend Studio User Guide.

Extracting Data using tSAPInfoCubeInput

You can retrieve data from an SAP application table using the
tSAPInfoCubeInput component.

This scenario applies only to subscription-based Talend products.

About InfoCube

In SAP, an InfoCube is an object that functions both as a data target and an InfoProvider.
There are several types of InfoCubes including the Basic InfoCube.

A Basic InfoCube physically stores data, and is filled with data using the SAP Business
Warehouse staging.

About this scenario

In this scenario, you extract data from a Basic InfoCube table, the
0FIGL_C10. As such, you need to enable some filtering to focus on various accounting
information such as Fiscal Period, Local Currency, Transaction Currency, Company Code, Cost
Center, and so forth.

Enabling the filters on the SAP system optimizes the extraction time.

To successfully extract accounting data from a Basic InfoCube table, perform the following

Checking BW Data Warehouse Workbench

Verify the values to be retrieved through the SAP application.

Ensure that you have access to your SAP Data Warehousing Workbench
  1. Login to your Data Warehousing Workbench application.
  2. Navigate to Modeling > InfoProvider > General Ledger (New): Transaction Figures.


  3. Display the data of 0FIGL_C10.


Retrieving the SAP BW metadata and running the Job

Add an SAP connection in Talend Studio and
design the Job with the tSAPInfoCubeInput component to retrieve data from the SAP

  1. Access Talend Studio.
  2. Navigate to Metadata > SAP Connections and create a connection.
  3. Right-click the newly created connection and select Retrieve SAP BW


  4. Import the 0FIGL_C10 SAP table. After importing, the table appears under the
    SAP InfoCube folder.
  5. Create a Standard Job with the following components:

    • tSAPConnection
    • tLogRow
    • tFileOutputDelimited
  6. Drag the 0FIGL_C10 SAP table from the SAP
    folder into the Job:


  7. Connect the components as shown in the previous step.
  8. Configure the 0FIGL_C10 tSAPInfoCubeInput


  9. Add your SAP connection details in the tSAPConnection
  10. Select the tFileOutputDelimited component and add the File Name details of the file where you want to
    store the output results after running the Job. You can find the File Name field
    in the Basic settings view.
  11. Click Run to execute the Job.

    When you open the file that you added in step 10, you
    retrieve the exact values exported from the SAP application table, 0FIGL_C10, as
    shown in step 3 of Checking BW Data Warehouse Workbench.

Document get from Talend https://help.talend.com
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x