July 30, 2023

tSAPODPInput – Docs for ESB 7.x

tSAPODPInput

Extracts business data from the ERP part of SAP (SAP Business application, SAP on
HANA, SAP R/3, and S4/HANA) through ODP (Operational Data Provisioning).

For more information about SAP ODP, see Operational Data Provisioning (ODP) and Delta Queue (ODQ).

tSAPODPInput Standard properties

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

The Standard
tSAPODPInput 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
Server
.

Client

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.

Language

The language of the SAP system.

Host name

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

System number

The SAP system number.

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

System ID

The SAP system ID.

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

Group Name

The SAP group name.

This property is available only when Message
Server
is selected from the Server
Type
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
fields.

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

  • 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
schema
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
    window.

Service name

The name of the operational delta queue.

For more information, see Introduction to Operational Delta
Queues
.

Subscriber name

The name of the subscriber that consumes data from SAP.

Subscriber process name

The name of the subscriber process.

Execute a full extraction

Select this check box to perform a full extraction to retrieve all data from
an SAP system. By default, this check box is cleared and a delta extraction
will be performed to retrieve only changed data.

Reset subscriber

Select this check box to reset the subscriber to make an initial load.

Selection 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
    Value
    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
selected:

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

  • Port: The listening port number of the FTP
    server.

  • 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
database.

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
connection
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

ERROR_MESSAGE

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

Usage

Usage rule

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

Limitation

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.

Support

You can use tSAPODPInput to interact with SAP S4/HANA.

Retrieving data from SAP through ODP

Here is an example of using Talend components to retrieve data from SAPt through ODP (Operational Data
Provisioning).

Creating a Job for retrieving data from SAP through ODP

The operational delta queue 0FI_GL_14, the subscriber
GCLAUSS, and the subscriber process
GCLAUSSN_FIGL14 to be used have been configured in SAP.
You can start transaction ODQMON in SAP GUI to monitor them.
For more information, see Introduction to Operational Delta Queues.

  1. Create a new Job and add a tSAPODPInput component and a
    tFileOutputDelimited component onto its design
    workspace.

    tSAPODPInput_1.png

  2. Connect the tSAPODPInput component to the
    tFileOutputDelimited component via a Row > Main connection.

Configuring the Job for retrieving data from SAP through ODP

  1. Double-click the tSAPODPInput component to open its
    Basic settings view.

    tSAPODPInput_2.png

  2. In the connection configuration related fields, specify the authentication
    information required to access your SAP system.
  3. Click the […] button to open the schema dialog box and
    define the schema by adding four columns, GJAHR,
    DMSHB, and HWAER of String
    type, and BUDAT of Date type with the date pattern
    yyyy-MM-dd, whose data will be retrieved.

    tSAPODPInput_3.png

    You can use the SAP metadata wizard to create a connection to your SAP
    system, save the connection in the Repository, retrieve the Business Content
    Extractor and its schema to be used, drag and drop the retrieved Business
    Content Extract node onto the Job design workspace as a
    tSAPODPInput component, and the connection
    configuration and the schema will be automatically filled. For more
    information, see the related description of centralizing SAP metadata.

  4. In the Service name field, enter the name of the
    operational delta queue to be used, 0FI_GL_14 in this
    example.
  5. In the Subscriber name and Subscriber process
    name
    fields, enter the names of the subscriber and subscriber
    process to be used, GCLAUSSN and
    GCLAUSSN_FIGL14 in this example.
  6. Select the Execute a full extraction check box to
    retrieve full data from the SAP system.
  7. Click the [+] button below the Selection
    Group
    table to add as many filters as needed to filter data to
    be retrieved and specify each filter.

    In this example, only the records whose BUDAT value is
    set between 1995-05-01 and
    1995-05-31 and is not equal to
    1995-05-22 will be retrieved, so the following
    two filters will be added.

    • One filter is set on the column BUDAT, with
      the sign Include, the operator
      Between, the low value
      19950501 and the high value
      19950530, which will filter the records
      whose BUDAT value is set between
      1995-05-01 and
      1995-05-31.

    • Another filter is also set on the column
      BUDAT, with the sign
      Exclude, the operator
      Equal, and the value
      19950522, which will filter out the
      records whose BUDAT value is equal to
      1995-05-22.

    To check which column can be used to define a filter, start transaction
    RSA2 in SAP GUI and display all fields definition
    for 0FI_GL_14, only the field whose
    Selection Poss. check box is selected can be used
    to define a filter.

    tSAPODPInput_4.png

  8. Double-click the tFileOutputDelimited component to open
    its Basic settings view.
  9. In the File Name field, specify the path to the file in
    which retrieved data will be written,
    D:/tsapodpinput_out.csv in this example.

Executing the Job to retrieve data from SAP through ODP

  1. Press Ctrl + S to save your Job.
  2. Press F6 to execute your Job.
  3. Open the file generated to check the retrieved data.

    tSAPODPInput_5.png

    You will find in the file that all records whose BUDAT
    value is set between 1995-05-01 and
    1995-05-31 and is not equal to
    1995-05-22 have been retrieved.


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