SAP ODP Extract private preview
  • Dark
    Light

SAP ODP Extract private preview

  • Dark
    Light

Note

This component is available for private preview from version 1.66 of Matillion ETL. Please consult your welcome pack for details on submitting feedback on this component.

Overview

The SAP ODP Extract component enables Matillion ETL users to connect directly through SAP ODP to access available data sources in SAPI and ABAP CDS views.

This component is in private preview and is currently only available for Matillion ETL for Snowflake. Accordingly, the documentation for this component is being updated continually at SAP ODP Extract.

This component includes many connection options that you may need to set. Read SAP ODP Connection Options for more information about these advanced connection options.

Given the nature of this component, pages for FAQs and for troubleshooting SAP ODP Extract are available and will be continuously updated.


Add SAP libraries

Using the SAP ODP Extract component requires three additional files—two from SAP, and one from Matillion. These files must be added to the location /usr/share/java/cdata/SAP/, which you can access via SSH.

SAP files

  1. Log in to SAP and access the JCo download software. If necessary, select the Tools and Services page to display the download page.
  2. Download the following files and ensure they are named as below:
    • libsapjco3.so — This is a "JCo" connection library.
    • sapjco3.jar — This is a Java wrapper.
  3. Download the most recent version of the SAP JCo 3.x for Linux.

Matillion ETL file

  1. Download this matillion-jco-wrapper.jar file.

Next steps

  1. Once you have downloaded the three files, add them to /usr/share/java/cdata/SAP/.
  2. Restart Tomcat.
Error
  • Without these additional files, you may get errors such as: SAP JCo library not found: verify the correct jar file is present..
  • With an incorrect password, or other authentication problem, you may get errors such as: Initialization of repository destination INERP_JCO_DESTINATION_NAME3 failed.

Properties

Name

Type: String

Description: A human-readable name for the component.


Connection

Type: Select

Description: The connection method. Choose either Direct or Load Balancer. The below parameters will change depending on the connection method.


Host

Type: String

Description: SAP ABAP application server host DNS. This is the host name of your target system. Direct connection only.


System Number

Type: Integer

Description: The system number of the SAP ABAP app server. Your system number should have been provided at the point of installation. For ECC, it is usually 10. For S/4H, it is usually 00. Direct connection only.


Message Server Host

Type: String

Description: SAP message server. This is a DNS or IP address. Load balancer only.


Message Server Service

Type: String

Description: An SAP message server port number, for example 3600. To resolve service names sapmsXXX, a lookup in etc/services is performed by the "network" layer of the operating system. If you're using port numbers instead of symbolic service names, no look-ups will be performed and no additional entries are needed.


Group Server

Type: String

Description: A group of SAP application servers. This parameter is used to identify the application servers used (the "logon group"). This parameter is optional for connecting via a load balancer and is only required when used by a customer on their SAP system. The default value is a single SPACE.


Authentication

Type: Select

Description: Select the authentication method. Options include Username/Password and SNC. The below parameters will change depending on the connection method.


Username

Type: String

Description: Your SAP username.


Password

Type: String | Select

Description: Your SAP login password. You can store the password in the component, or use Manage Passwords to create a masked entry for the password. Using Manage Passwords is recommended.


SNC Partner Name

Type: String

Description: (JCO_SNC_PARTNERNAME). SNC name of the communication partner server. For example, p:CD=SID, O=ACompany, C=EN. Find the app server SNC name in the profile parameter snc/identity/as on SAP NetWeaver application server for ABAP. This parameter is required for SNC. The default length is 256 characters. The fields JCO_SNC_MYNAME and JCO_SNC_PARTNERNAME are LDAP names.


SNC Library Path

Type: String

Description: (JCO_SNC_LIBRARY). An SNC library path. It is the path to the SNC library on the client machine (SAP GUI). The default setting is the system-defined library as defined in the environment variable SNC_LIB. Destination service uses the property snc/gssapi_lib on SAP NetWeaver AS for Java. This parameter is optional.


SNC MyName

Type: String

Description: (JCO_SNC_MYNAME). Specify the SNC name. When left blank and SNC is enabled, JCo derives the value. For example, p:CD=SID, O=ACompany, C=EN. This parameter is optional, but it is recommended to set it to ensure that the correct SNC name is used for the connection. Destination services require it be set in the property snc/identity/as on SAP NetWeaver application servers for Java. The default length is 256 characters.


SNC Quality of Protection

Type: Integer

Description: (JCO_SNC_QOP). SNC "quality of protection". This parameter is optional. The values available are: 1 for authentication only. 2 for authentication and integrity protection. 3 for authentication, integrity, and privacy protection (encryption). 8 for the global default configuration (equivalent to 3). 9 for maximum protection.


Client

Type: Integer

Description: SAP client. The default is 100. From SAP help: "A SAP client is defined as a self-contained commercial, organizational, and technical unit within an SAP system. All business data within a client are protected from other clients." Read more about this at Customer Data and System Data.


Language

Type: Language code

Description: Defaults to en. If not defined, the SAP system returns to JCo the default user language, and JCo will use that default value. Language codes adhere to ISO 639-1 codes.


Connection Options

Type: Parameter

Description: Additional connection options for SAP ODP. Add a new row with +; remove a row with -; or click Add All. Documentation for each of these connection options can be found here.


Value

Description: A value for the given connection parameter.


Context

Type: Select

Description: List of contexts available in the SAP system for the subscriber type SAP_BW. The context acts as a "data provider" for the data source. In SAP, a data provider permits configuration of data for extraction when targeting a specific use. For example, usage in BW/4Hana versus BW.


Search

Type: String

Description: Search string used to identify and reduce the quantity of data sources returned by SAP. For example, in this parameter you may wish to use the string TEXT.


Data Source

Type: Select

Description: In the context of SAP ODP, a data source is an "extractor". In SAP, an extractor is a data extraction through a specified context. A data source can be the result of aggregation of one or more tables or views in SAP. Data sources are listed where a match with the Search parameter has been ascertained. A semantic character is also provided. Additionally, a contextual description is given where a data source has been provided with description metadata in SAP.

The data sources available show a concatenation of:

  • The data source technical name.
  • A semantic (the SAP type of data source).
  • The SAP data source description, in the language specified at login.

Semantics glossary:

H = Hierarchy

F = Transaction Data/Facts

P = Master Data/Attributes

T = Texts

V = View


Data Selection

Type: Dual Listbox

Description: Columns to include in the extraction. Columns will also have a contextual description where applicable.


Data Source Filter

Type: Input Column

Description: Select an input column for your filter. The available input columns vary depending upon the data source.


Qualifier

Description:

  • Is: Compares the column to the value using the comparator.
  • Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.

Comparator

Description: Select the comparator.
Choose one of "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", or "Between".
"Equal to" can match exact strings and numeric values, while other comparators such as "Greater than" and "Less than" will work only with numerics. The "Like" comparator allows the wildcard character % to be used at the start and end of a string value to match a column. "Between" allows a range comparison, including within the range, external to the range, from a value, and up to a value. With "Between", the two values must be separated by a comma.

Dates should be provided in the SAP data format.

Numbers—for example, customer numbers—have to follow the SAP data format. For example, 10 digits for a customer number (KUNNR), with values like ‘0003000020’.

Note

Not all data sources support all comparators, meaning that, often, only a subset of the above comparators will be available for selection.


Value

Description: Specify the value to be compared.


Load Type

Type: Select

Description: Select a load type to manage the quantity of data sent via the network—especially useful when dealing with large RFC table parameters. Available options depend on your chosen data source. When Full is selected, the whole table is sent back to the caller. When Delta is selected, only appended, deleted, and updated table rows are transferred back to the caller.


Max Package Size

Type: Numeric

Description: Byte integer representing the package size of the data in SAP. The default setting is 100,000 bytes.


Subscriber Name

Type: String

Description: The subscriber is the consumer of the data. Subscriber name is assigned by the user to allow the identification of which app is consuming the data. The maximum string size is 32 characters.


Subscriber Process

Type: String

Description: The extraction process of the subscriber. The maximum string size is 64 characters.


Subscriber Run

Type: String

Description: The run ID of the subscriber. For example, ${dt.now()} The maximum string size is 64 characters. This parameter is optional.


Location

Type: Select | String

Description: Select a storage location. The cloud storage buckets available for selection depend on the credentials you have set up in Manage Credentials.


Warehouse

Type: Select

Description: Select the Snowflake warehouse. The special value, [Environment Default], will use the warehouse defined in the Matillion ETL environment. For more information, read Virtual Warehouses.


Database

Type: Select

Description: Select the Snowflake database. The special value, [Environment Default], will use the database defined in the Matillion ETL environment. For more information, read Databases, Tables, and Views.


Schema

Type: Select

Description: Select the Snowflake schema. The special value, [Environment Default], will use the schema defined in the Matillion ETL environment. For more information, read Database, Schema, and Share DDL.


Target Table

Type: String

Description: Provide a new table name.

Warning

This table will be recreated on each run of the job and drop any existing table of the same name.