# tSAPADSOInput

Retrieves data of an active ADSO (Advanced Data Store Object) from an SAP BW system on an SAP HANA database or through SAP Java Connector.

## tSAPADSOInput Standard properties

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

The Standard tSAPADSOInput component belongs to the Business family.

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

Information noteNote: When prompted that this component requires sapjco.jar, download the module and refer to the instructions at [SAP Java Connector](https://support.sap.com/en/product/connectors/jco.html).

## Basic settings

| Properties | Description |
| --- | --- |
| Property Type | Either Built-In or Repository.<br><br><ul> <li> <p> <span>Built-In</span>: No property data stored centrally.</p> </li> <li> <p> <span>Repository</span>: Select the repository file where the            properties are stored.</p> </li> </ul> |
| Connection type | Select the way to retrieve ADSO data, Hana JDBC or<br>SAP JCO 3.<br><br><ul> <li> <span>Hana JDBC</span>: retrieves ADSO data through a JDBC                        connection to an SAP HANA database.</li> <li> <span>SAP JCO 3</span>: retrieves ADSO data through SAP Java                        Connector.</li> </ul><br><br>Information noteNote: This option is available only when you have<br>installed the R2021-12 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator. |
| Host | Enter the IP address or hostname of the database.<br><br>This option is available<br>when Hana JDBC is selected from the<br>Connection type drop-down list. |
| Port | Enter the listening port number of the database.<br><br>This option is available<br>when Hana JDBC is selected from the<br>Connection type drop-down list. |
| Table Schema | Enter the table schema name.<br><br>This option is available when Hana<br>JDBC is selected from the Connection type<br>drop-down list. |
| Username and Password | Enter the database user authentication data.<br><br>To enter the password, click<br>the [...] button next to the password field, and then in<br>the pop-up dialog box enter the password between double quotes and click<br>OK to save the settings.<br><br>These two options are<br>available when Hana JDBC is selected from the<br>Connection type drop-down list. |
| Schema and Edit schema | A schema is a row description. It defines the number of fields<br>(columns) to be processed and passed on to the next component. When you create a Spark<br>Job, avoid the reserved word line when naming the<br>fields.<br><br><ul> <li> <p> <span>Built-In</span>: You create and store the schema locally for this component                only.</p> </li> <li> <p> <span>Repository</span>: You have already created the schema and stored it in the                Repository. You can reuse it in various projects and Job designs.</p> </li> </ul><br><br>Click Edit schema to make changes to<br>the schema. If you make changes, the schema automatically becomes built-in.<br><br><ul> <li> <p> <span>View schema</span>: choose this                option to view the schema only.</p> </li> <li> <p> <span>Change to built-in property</span>:                choose this option to change the schema to <span>Built-in</span> for local changes.</p> </li> <li> <p> <span>Update repository connection</span>:                choose this option to change the schema stored in the repository and decide whether                to propagate the changes to all the Jobs upon completion.</p> <p>If you just want to                propagate the changes to the current Job, you can select <span>No</span> upon completion and choose this schema metadata                again in the <span>Repository Content</span>                window.</p> </li> </ul> |
| Name | Enter the name of the active Advanced Data Store Object from which data will<br>be retrieved.<br><br>This option is available when Hana JDBC is<br>selected from the Connection type drop-down<br>list. |
| Use an existing connection | Select this check box and from the Connection<br>configuration drop-down list displayed, select the component in<br>which the relevant reused database connection is configured.<br><br>When a Job contains<br>a parent Job and a child Job, the list displayed presents only the connection<br>components in the same Job level.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list. |
| Server Type | Select the type of the SAP server to be connected, either<br>Application Server or Message<br>Server.<br><br>This option is available when SAP JCO<br>3 is selected from the Connection type<br>drop-down list. |
| Client | Enter the SAP system client ID.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list. |
| UserId and Password | Enter the user connection ID and password.<br><br>To enter the password, click<br>the [...] button next to the password field, and then in the pop-up dialog box<br>enter the password between double quotes and click OK to save the<br>settings.<br><br>These two options are available when SAP JCO<br>3 is selected from the Connection type<br>drop-down list. |
| Language | Enter the language of the SAP system.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list. |
| Host name | Enter the name or IP address of the host on which the SAP server is<br>running.<br><br>This option is available when SAP JCO 3 is<br>selected from the Connection type drop-down<br>list. |
| System number | Enter the SAP system number.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list and Application<br>Server is selected from the Server Type<br>drop-down list. |
| System ID | Enter the SAP system ID.<br><br>This field is available when SAP JCO<br>3 is selected from the Connection type<br>drop-down list and Message Server is selected from the<br>Server Type drop-down list. |
| Group Name | Enter the SAP group name.<br><br>This field is available when SAP JCO<br>3 is selected from the Connection type<br>drop-down list and Message Server is selected from the<br>Server Type drop-down list. |
| Service name | Enter the name of the operational delta queue.<br><br>For more information, see<br>[Introduction to Operational Delta Queues](https://wiki.scn.sap.com/wiki/display/BI/Introduction+to+Operational+Delta+Queues#IntroductiontoOperationalDeltaQueues-TheOperationalDeltaQueue%28ODQ%29).<br><br>This<br>option is available when SAP JCO 3 is selected from the<br>Connection type drop-down list. |
| Subscriber name | Enter the name of the subscriber that consumes data from SAP.<br><br>This option<br>is available when SAP JCO 3 is selected from the<br>Connection type drop-down list. |
| Subscriber process name | Enter the name of the subscriber process.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list. |
| Execute a full extraction | Select this check box to perform a full extraction to retrieve all data from<br>an SAP system. By default, this check box is cleared and a delta extraction will<br>be performed to retrieve only changed data.<br><br>This option is available when<br>SAP JCO 3 is selected from the Connection<br>type drop-down list. |
| Reset subscriber | Select this check box to reset the subscriber to make an initial<br>load.<br><br>This option is available when SAP JCO 3 is<br>selected from the Connection type drop-down<br>list. |
| Selection Group | Specify the search condition(s) used to filter data to be retrieved by<br>clicking the [+] button to add as many rows as needed, each<br>row for a search condition, and set the value of the following attributes for each<br>condition.<br><br>Information noteNote: This component retrieves the data records that meet all the<br>conditions set in this field.<br><br><ul> <li> <p> <span>Column</span>: enter the name of the schema column based                           on which retrieved data will be filtered.</p> </li> <li> <p> <span>Sign</span>: select either <kbd>Include</kbd>                           or <kbd>Exclude</kbd> from the drop-down list.</p> <ul> <li> <p> <kbd>Include</kbd>: the data that meets the condition                                 will be retrieved.</p> </li> <li> <p> <kbd>Exclude</kbd>: the data that doesn't meet the                                 condition will be retrieved.</p> </li> </ul> </li> <li> <p> <span>Operator</span>: select from the drop-down list the data                           filter operator used to build the search condition.</p> </li> <li> <p> <span>Value</span>: specify the search value used to build the                           search condition. Note that wildcard characters are not supported.</p> </li> <li> <p> <span>High value</span>: specify another search value used to                           build the search condition for the <span>Between</span>                           operator.</p> <p>When using a column of Date type to specify a filter, the date and time                           values in the <span>Value</span> and <span>High                              Value</span> columns should be in the format                              <kbd>yyyyMMdd</kbd> and <kbd>HHMMSS</kbd>,                           which might be different from the format defined in the schema editor.                           Note that wildcard characters are not supported.</p> </li> </ul><br><br>This table is available when SAP JCO 3 is selected<br>from the Connection type drop-down list. |
| Specify a shared destination | Select this check box and specify the shared destination in the<br>Shared destination name field displayed. The shared<br>destination allows the SAP components to use the shared destination on the<br>Talend Runtime<br>when they are executed as part of an ESB Route or ESB Data Service within the<br>Talend Runtime<br>container OSGi Environment.<br><br>Besides specifying the shared destination name in<br>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<br>are described in the readme.txt provided in the Talend ESB package in the /add-ons/datasource/sap<br>folder.<br><br>Note that if you use the component's own connection<br>configuration, your SAP connection will be closed at the end of the component.<br>To prevent this from happening, use a shared destination with its name<br>specified.<br><br>This option is available when SAP JCO 3<br>is selected from the Connection type drop-down<br>list. |

## Advanced settings

| Properties | Description |
| --- | --- |
| Additional JDBC Parameters | Enter additional JDBC parameters in the format of<br>parameterName1=value1&parameterName2=value2&....<br>This field allows you to provide metadata for Advanced DataStore Objects.<br><br>This<br>option is available when you select Hana JDBC from the<br>Connection type drop-down list. |
| Fetch size | Enter the maximum size of the resultset (in number of rows) that can be<br>returned from the SAP BW database in response to a BAPI call or a request.<br><br>A<br>value of -1, the default, uses the default fetch size,<br>which is determined by the Java code or the BAPI on SAP side.<br><br>It is<br>recommended to set this field according to the memory space allocated to your<br>Job and the number of fields requested. With a given memory space, the more<br>fields requested, the smaller the fetch size.<br><br>This option is available<br>when SAP JCO 3 is selected from the<br>Connection type drop-down list. |
| SAP Properties | If you need to use custom configuration for the SAP system being used,<br>complete this table with the property or properties to be customized. For example,<br><br><ul> <li> <p>to establish a Unicode connection between the SAP system and <span>Talend Studio</span>, you need to add the property                              <kbd>jco.server.unicode</kbd> and set its value to                              <kbd>1</kbd>. Note that this property works if you are                           using SAP Java Connector 2.x and is unnecessary for SAP Java Connector                           3.0 and higher versions. </p> </li> <li> <p>to set up an SAP connection with Secure Network                           Communications (SNC), you need to add and set the following properties in                           this field.</p> <ul> <li> <span>jco.client.snc_mode</span> </li> <li> <span>jco.client.snc_myname</span> </li> <li> <span>jco.client.snc_lib=.../sapcrypto/sapcrypto.dll</span> </li> <li> <span>jco.client.snc_partnername</span> </li> <li> <span>jco.client.snc_qop</span> </li> </ul> <div><span>Information note</span><span>Note:</span>  The values of the above properties vary with                           the system environment. Contact your SAP system administrator if you are                           not sure how to set the properties.</div> <p>For more information about setting the SNC parameters, see <a href="https://help.sap.com/viewer/10977ac76c531014a966b3f130d4f853/7.0.36/en-US/d9e8a740bbaa4d8f8bee6f7b173bd99f.html" target="_blank">Configuring SNC: External Programs to AS ABAP Using                              RFC</a> and <a href="https://help.sap.com/viewer/10977ac76c531014a966b3f130d4f853/7.0.36/en-US/76128150317a47b6a326e63a17017729.html" target="_blank">Communication Paths that Support SNC</a>.</p> </li> </ul><br><br>This table is available when SAP JCO 3 is selected from<br>the Connection type drop-down list and the<br>Use an existing connection check box is not selected<br>in the Basic settings view. |
| Convert NULL numeric values to zero | Select this check box to allow automatic conversion of NULL numeric fields<br>to zero during data extraction. |
| Set max length for variable length type | Select this check box to define a custom maximum length for variable-length<br>type fields, such as XXL InfoObject fields, when reading data from an SAP BW aDSO.<br>By default, this check box is cleared and a default length of 100 characters is<br>applied, which may result in truncation of longer values. |
| Max length | Enter the maximum number of characters to read for variable-length type<br>fields. The default value is 100.<br><br>This field is available<br>when the Set max length for variable length type check<br>box is selected. |
| tStatCatcher Statistics | Select this checkbox to gather the Job processing metadata at the Job level<br>as well as at each component level. |

## Global Variables

| Variables | Description |
| --- | --- |
| ERROR\_MESSAGE | The error message generated by the component when an error<br>occurs. This is an After variable and it returns a string. |

## Usage

| Usage guidance | Description |
| --- | --- |
| Usage rule | This component is usually used as a start component of a Job or<br>subJob and it always needs an output link. |

**Related concepts**

* [Retrieving ADSO data from SAP BW](https://help.qlik.com/talend/en-US/components/8.0/sap/tsapadsoinput-tfileoutputdelimited-retrieving-adso-data-from-sap-bw-standard-component-enterprise "This sample scenario shows you how you can use Talend components to retrieve data of an active ADSO (Advanced Data Store Object) from an SAP BW system on an SAP HANA database.")