This component is only available for use with Hybrid SaaS agents.
Storage Blob Data Contributor role. For more information, read User assigned with the Storage Blob Data Contributor role.
Uploading SAP drivers
Drivers for SAP ODP are not natively included in Hybrid SaaS agents, but can be uploaded to your agent instance using the process in Uploading external drivers to the agent. Two driver files are required:sapjco3.jarlibsapjco3.so
Properties
Reference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.A human-readable name for the component.
Connect
Select the authentication method. Only Username/Password is supported currently.
Your SAP username.
The secret definition holding your password tied to your username for your SAP account. Your password should be saved as a secret definition before using this component.
The connection method. Choose either Direct or Load Balancer. The following connection parameters will change depending on the connection method.
Select either None or TLS. Only required if Server Connection is Direct. For TLS encryption, a Web Socket Host, Web Socket Port, and TLS/SSL Certificate are required. For no encryption, a Host and System Number are required.
SAP ABAP application server host DNS. This is the host name of your target system. Only required for Direct server connections with no encryption.
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. Only required for Direct server connections with no encryption.Enter the host name for the TLS encrypted WebSocket connection. Only required for Direct server connections with TLS encryption.
Enter the port number used for the TLS encrypted WebSocket connection. Only required for Direct server connections with TLS encryption.
The TLS encryption certificate. Paste the text content of the certificate into the TLS/SSL Certificate dialog. Only required for Direct server connections with TLS encryption.
Enter the DNS host name or IP address of the SAP message server. Only required for Load Balancer connections.
Enter a SAP message server port number. This is optional. 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. Only required for Load Balancer connections.If using a group of SAP application servers, use this property to identify the application servers used (the “logon group”). This parameter is optional and is only required if used on your SAP system. The default value is a single
SPACE. Only required for Load Balancer connections.Enter the SAP client number. 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.
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.Additional connection options for SAP ODP. Add a new row with +; remove a row with -; or click Add All. For each connection option, select the Parameter from the drop-down list and enter its Value as a string.
Configure
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.Search string used to identify and reduce the quantity of data sources returned by SAP. This is optional. For example, enter
TEXT to filter the list of data sources to those containing the string “text”. The maximum search string length is 30 characters.Select the SAP ODP data source. Set the Data Source Search Term property as a filter to limit the items in the list, if required.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. 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.
Columns to include in the extraction. Columns will also have a contextual description where applicable. This property is optional.
- Input Column: Select an input column. The available input columns vary depending upon the data source.
- Qualifier:
- 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: Choose a method of comparing the column to the value. Possible comparators include: “Equal to”, “Greater than”, “Less than”, “Greater than or equal to”, “Less than or equal to”, “Like”, “Null”. “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” operator allows the wildcard character
%to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to. Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from. - Value: The value to be compared.
Select a load type to manage the quantity of data sent via the network. This is especially useful when dealing with large RFC table parameters. Available options depend on your chosen data source. Possible types are Full Load, Delta Load, and Recovery (available only if the data source supports deltas). The default is Full Load.When Full Load 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.
Only used if Load Type is Delta. To only extract changes (creates, modifications, and deletes) from now onwards, enter
X. Leave blank (the default) to also return historical changes.Only available if the data source supports deltas, and the Load Type is Recovery.SAP ODP allows you to repeat the extraction of data that may have been lost or corrupted due to an interruption of service, to restore and guarantee the data integrity of the extracted data. A recovery pointer is set by SAP ODP at a specific point-in-time in the delta queue, and you can use this to recover any data change recorded from that point onward. When the recovery pointer is set and the pipeline repeated, all the data changes that happened from that recovery pointer onward are extracted, while all data changes that happened before that recovery pointer are not extracted.You must obtain the value of the recovery pointer from the Replication Pointers table in SAP. After a data extraction that you believe to have been interrupted, refresh the SAP Replication Pointers table and make a note of the pointer. The pointer is a string of digits in the following format:
20240131082113.000021000. This is a year-month-day-hour-minute-second timestamp, and must be in this exact format; any format other than this will lead to an error. This string should be entered in the Recovery Pointer property to tell the component where in the delta queue to begin the recovery run.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.
The identifier for the extraction process of the subscriber. The maximum string size is 64 characters.
The run ID of the subscriber. For example,
${dt.now()} The maximum string size is 64 characters. This property is optional.Destination
Select your cloud data warehouse.- Snowflake
- Databricks
- Amazon Redshift
Select the destination for your data. This is either in Snowflake as a table or as files in cloud storage.
- Snowflake: Load your data into a table in Snowflake. The data must first be staged via Snowflake or a cloud storage solution.
- Cloud Storage: Load your data directly into files in your preferred cloud storage location. The format of these files can differ between source systems and will not have a file extension so we suggest inspecting the output to determine the format of the data.
- Snowflake
- Cloud Storage
The Snowflake warehouse used to run the queries. The special value
[Environment Default] uses the warehouse defined in the environment. Read Overview of Warehouses to learn more.The Snowflake database to access. The special value
[Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.The Snowflake schema. The special value
[Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.The name of the table to be created in your Snowflake database. You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded.
Define what happens if the table name already exists in the specified Snowflake database and schema.
- Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
- Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
- Fail if Exists: If the specified table name already exists, this pipeline will fail to run.
- Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It’s appended onto the end of the existing data in the table. If the specified table name doesn’t exist, then the table will be created, and your data will be inserted into the table.
- Yes: Staged files will be destroyed after data is loaded. This is the default setting.
- No: Staged files are retained in the staging area after data is loaded.
Select the stage access strategy. The strategies available depend on the cloud platform you select in Stage Platform.
- Credentials: Connects to the external stage (AWS, Azure) using your configured cloud provider credentials. Not available for Google Cloud Storage.
- Storage Integration: Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the Storage Integration property, through which you can select any of your existing Snowflake storage integrations.
Use the drop-down menu to choose where the data is staged before being loaded into your Snowflake table.
- Amazon S3: Stage your data on an AWS S3 bucket.
- Snowflake: Stage your data on a Snowflake internal stage.
- Azure Storage: Stage your data in an Azure Blob Storage container.
- Google Cloud Storage: Stage your data in a Google Cloud Storage bucket.
Advanced Settings
Byte integer representing the package size of the data in SAP. The default setting is 5,000,000 bytes.Max Package Size is based on the size of the package in SAP, measured in compressed bytes. This size may need to be tweaked depending on the content of the package and the size constraint of the cloud data platform.
Converts common strings that represent null into a null value. This is case-sensitive and works with the following strings: "", “NULL”, “NUL”, “Null”, “null”. The default is No.
Currently, this property is only applicable when using Snowflake as your destination.
Deactivate soft delete for Azure blobs (Databricks)
If you intend to set your destination as Databricks and your stage platform as Azure Storage, you must turn off the “Enable soft delete for blobs” setting in your Azure account for your pipeline to run successfully. To do this:- In the Azure portal, navigate to your storage account.
- In the menu, under Data management, click Data protection.
- Clear the Enable soft delete for blobs checkbox. For more information, read Soft delete for blobs.