tSAPDSOInput Standard properties

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.

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

This 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, see Talend Studio User Guide.

This 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.

Name

Enter the name of the Data Store 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 retrieved.

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. Note that wildcard characters are not supported.

• 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. Note that wildcard characters are not supported.

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.

Fetch size

Enter the maximum size of the resultset (in number of rows) that can be returned from the SAP BW database in response to a BAPI call or a request.

A value of -1, the default, uses the default fetch size, which is determined by the Java code or the BAPI on SAP side.

It is recommended to set this field according to the memory space allocated to your Job and the number of fields requested. With a given memory space, the more fields requested, the smaller the fetch size.

SAP Properties

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

SAP function extraction path

Select this option to specify a directory for the SAP function to generate files that hold the data extracted. You can enter the path to the directory in the text field to the right.

If this option is not selected, the files will be generated in the directory specified in the FTP directory field in the Basic settings view.

This option is available when you select the Use FTP-Batch Options option in the Basic settings view.

Because Talend Studio does not synchronize the directories specified by SAP function extraction path and FTP directory fields, make sure these two fields point to the same resource.

tStatCatcher Statistics

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

ERROR_MESSAGE

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.

Limitation

Currently only the fields of the DSO itself can be extracted. The extraction of navigation attributes is not supported.