SAP Smart Data Integration
SAP Smart Data Integration
1 SAP Smart Data Integration (SDI) for SAP SuccessFactors Incentive Management. . . . . . . . . . 3
5 Deploying Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.1 Export Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
5.2 Import Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6 References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
• SAP Smart Data Integration (SDI) for SAP SuccessFactors Incentive Management [page 3]
• SAP SuccessFactors Incentive Management - SAP Smart Data Integration Architecture [page 7]
• Getting Started Checklist [page 5]
• Inbound and Outbound Transfers [page 16]
Implementation
Quick Links
• Data Integration in SAP SuccessFactors Incentive Management Using SAP Smart Data Integration [page
4]
• Getting Started Checklist [page 5]
• Glossary [page 8]
SAP Smart Data Integration (SDI) is a component of the HANA platform that facilitates receiving, transforming,
and loading data to and from the HANA database. Capabilities include high-volume data loads, real-time and
batch data movement, high-speed data provisioning, and data transformation.
Note
It is recommended NOT to store any Personal Identifying Information (PII) in Sales Transactions Generic
Attributes/Generic Numbers. If PII data is sent in transaction data, the PII attributes can be removed by
specifying the retention period in Preferences > System Preference > Data Protection Policy.
Make sure that transaction PII attributes are not used in Rules and Formulas because once these PII
attributes are purged (after the specified retention date), reprocessing pipelines for prior periods might not
yield accurate results.
SAP Smart Data Integration (SDI) is packaged as part of SAP SuccessFactors Incentive Management and can
be used to integrate your on-premise systems with SAP SuccessFactors Incentive Management on HANA.
Smart Data Integration (SDI) allows you to securely transfer critical business data to and from SAP
SuccessFactors Incentive Management, enabling you to easily synchronize and share data within your
organization.
Prerequisite
Understanding of data integration concepts, knowledge of SDI, Web IDE, HANA SQL and procedures is a
prerequisite for implementing SAP Smart Data Integration with SAP SuccessFactors Incentive Management on
HANA.
Related Topics
Note
Understanding of data integration concepts, knowledge of Smart Data Integration (SDI), Web IDE,
HANA SQL and procedures is a prerequisite for implementing SDI with SAP SuccessFactors Incentive
Management (HANA).
Use this checklist to get started with the setup and configuration process. Make sure you have all the
information handy before you proceed:
S-User ID -
Required to download DP
Agent
Tenant DB Name -
Provided in provisioning
email
Required to connect to
Tenant DB from WebIDE
Required to import/export
projects and create
flowgraphs
HANA DB credentials -
Provided in provisioning
email
SAP Smart Data Integration (SDI) is packaged as part of HANA Enterprise which comprises the following
components:
The Data Provisioning agent is installed in the customer’s premise and is set up to connect with SAP Smart
Data Integration (SDI) and the HANA DB Server. The DP Agent connects to the data source systems (Hadoop,
Every SAP SuccessFactors Incentive Management solution is provisioned with a separate HANA tenant
database. Web IDE facilitates access to the HANA database and Smart Data Integration (SDI) components.
A development space is provisioned in Web IDE XSA (Extended Application Service) to enable application
developers to manage content integration development. The Web IDE DB Explorer plugin allows users to
connect to the tenant database and access the schemas.
Related Topics
2.4 Glossary
Commonly used terms in SAP SuccessFactors Incentive Management - SAP Smart Data Integration (SDI)
integration are described below:
Term Definition
Incentive Management Stage Tables Temporary data storage area in Incentive Management
where data from Smart Data Integration (SDI) is placed dur-
ing export. Data is validated in the staging area before trans-
ferring into the Incentive Management tables and executing
the pipeline.
DP Agent The Data Provisioning Agent hosts all Smart Data Integration
(SDI) Adapters and acts as the communication interface
between Hana and the Adapter.
Flat File Flat file allows you to specify data attributes, such as col-
umns and data types table by table, and stores the data in
plain text format.
Virtual Table A HANA component, which allows read and write of data
from external sources.
Web IDE
SAP Web IDE is a browser-based integrated development
environment (IDE), comprised of web-based UIs, business
logic, and extensive SAP HANA data models, that are lever-
aged by Smart Data Integration (SDI).
The following components need to be set up and configured to implement Smart Data Integration with SAP
SuccessFactors Incentive Management for data integration:
Note
Related Topics
The Data Provisioning Agent is a lightweight component that hosts data provisioning adapters, enabling data
federation, replication, and transformation scenarios for deployments. It provides secure connectivity between
the SAP HANA database and your on-premise adapter-based sources.
Note
For best performance, we recommend that you install the Data Provisioning Agent on a separate machine
or in a virtual machine as close to the source database as possible.
1. Download DP Agent. You can download the DP Agent and SAPCAR file from the SAP Support portal .
Note
You can also install DP Agent from the HANA Tools site.
Related Topics
For connectivity issues, check the Data Provisioning Agent Logs (available at DP Agent Operating System level)
to resolve the problem.
If the issue persists, make sure the DP Agent server is able to access HANA over the internet and there are no
Firewalls blocking the connection. If everything looks okay, and the connectivity is still not established, raise an
incident with SAP support in support.sap.com using your “S” user account.
Related Topics
Web IDE facilitates access to HANA database and SDI components. To connect to Web IDE, you need the
following details:
Launch the Web IDE URL and provide the username and password.
You will be prompted to change your initial password after the first login.
EXT Schema is the Incentive Management HANA database schema which allows creating custom HANA tables
and procedures. In Web IDE, launch DB Explorer to connect to EXT Schema.
1. Launch DB Explorer from Web IDE. After logging in to Web IDE, click the DB Explorer icon on the left panel.
The DB Explorer interface is displayed.
Note
Do not select the Save user and password (stored in the SAP HANA secure store) option at this point
because you will be prompted to change this initial password when you first log in.
Overview
A typical Extract, Load and Transform pattern would involve 4 primary stages as illustrated below. Data is first
loaded into the EXT Schema typically where it is transformed, cleansed, and validated before being loaded
into the Incentive Management Staging tables. After data is loaded into the staging tables, a flowgraph calls
the ODATA API (using ODATA adapter) to execute the Incentive Management Pipeline to import data from the
Staging tables to the main Incentive Management tables. Users can use monitors to track agents and execution
of tasks.
In the first stage, data is federated in the virtual table in DB Explorer from the remote data source.
Pre-requisite: Create a remote source in the HANA tenant database via Web IDE DB Explorer to be able to
create virtual tables.
Note
A remote source owner can create or grant privileges for creating virtual tables on a remote source.
Alternatively, remote source creation can be done as PS_ <user>.
In this stage, data is loaded into the EXT schema table from the virtual table. Typically, users create the same
table structure in EXT schema as in the source table and then load data. This step is executed using flowgraphs
that are built in Web IDE.
Transformations are possible in this stage but are not performed since this is mainly an Extract and Load step.
In this stage, data is transformed and moved from the EXT schema table to the TCMP schema table. This step
is executed using flowgraphs that are built in Web IDE.
In the final stage, data is moved to the main Incentive Management table from the TCMP table.
To achieve this, the Incentive Management pipeline is triggered. Once the Incentive Management pipeline is
executed, data is moved from the TCMP stage table to TCMP main table.
Web IDE project uses the HDI (HANA Deployment Infrastructure) service layer to deploy HANA database
artifacts. HDI also introduces HDI container for database. HDI container is essentially a database schema.
It abstracts the actual physical schema and provides schema-less development to the Web IDE project. The
physical schema is abstracted by the HDI container. Only local object (HDI container schema) access is allowed
from the Web IDE application. Two technical users (Object Owner and Schema Owner) are also created.
Technical users have access to only the local objects. Any foreign object (such as tables in EXT and TCMP
schema) must be accessed via Synonyms and must be granted access by the foreign technical user (tenant
database user).
Development Steps:
Note
<TECHNICAL_USER>#OO should have privileges granted with grant option for all EXT objects which
users use in that specific project (and on all objects they have created synonyms for). Alternatively,
to manage the required permissions on the tables, users can create a .hdbgrants file to handle the
table permissions.
Note
If you choose to use the History Preserving Flowgraph component with HANA SPS 05, it is highly
recommended to have a logical key defined in the component’s target table. It is also recommended
that the columns for the logical key are picked as follows:
Related Articles
In an inbound transfer, data will be copied from the source system/flat files and loaded into the Incentive
Management tables.
Note
Data can be loaded from various data sources. As an example, the procedure to transfer data from flat files
is illustrated in this documentation. Any Smart Data Integration (SDI) compatible template can be used to
create flat files.
Steps
The following image illustrates the steps involved in an Inbound File Transfer.
URL: https://<commissionshostname>:447/TrueComp-SaaS/CommissionsService.svc/PipelineRuns
"StartDateScheduled": "2019-06-06T14:57:00Z",
"TraceLevel": null,
"SkipAnalyzeSchema": null,
"SqlLogging": null,
"DebugContext": null,
"Command": "Import",
"StageType": "ValidateAndTransfer",
"Period": {
"Calendar": {
},
},
"BatchName": "BATCH1",
"RunMode": "all",
To monitor load status and logs, see Monitor Tasks [page 26].
Note
Calling the ODATA adapter to execute the Incentive Management pipeline can be part of a flowgraph and
scheduled in a task chain.
Related Articles
In outbound transfer, data is copied from EXT Schema which has read access Incentive Management tables
(TCMP) and loaded into the target.
Note
Data can be extracted into various data systems. As an example, the procedure to transfer data to flat files
is illustrated in this documentation.
Steps
The following image illustrates the steps involved for an Outbound File Transfer.
Optionally, you can create additional flowgraphs to meet your requirements and chain flowgraphs.
To monitor data transfer status and logs, see Monitor Tasks. [page 26]
Related Articles
When developing Flowgraphs, check the Console in Web IDE to view data transfer progress, status messages,
and logs.
Data Provisioning Monitor is a browser-based interface that lets you monitor information about tasks.
Data Provisioning Task Moni- https://<<server>>/sap/ Monitor information about Operations Team
tor hana/im/dp/monitor/in- replication tasks and trans-
dex.html?view=IMTaskMoni- formation tasks. Details in-
tor clude duration of a task,
number of records processed
etc.)
When WebIDE project with HANA module is deployed, the system creates an additional schema:
“<ProjectName>”_HDI_”<HDIModuleName>”_1#OO.
1. Log on to Webide/DBExplorer and launch SQL Console (Admin) in the respective container.
3. Log on to DPAgent Task Monitor and check that every flowgraph in the given HANA
module (such as JUNEMOD and HDBPARTICIPANT as shown in the above example) is
available and authorized for execution and scheduling to the DP Agent Task Monitoring users.
Note
To schedule custom stored procedures, use XSJS Jobschedule. See Incentive Management - SDI Job
Scheduler XSJS for more details.
Also, see Making HDI containers accessible to a classic database user for additional information on HDI
containers.
Related Articles
• View Progress, Status Messages, and Logs in WEB IDE [page 25]
• Inbound and Outbound Transfers [page 16]
You can migrate the entire Web IDE XSA Project to another environment. You can also import projects from
other environments.
Related Articles
Standard Option
Perform the following steps to export a project using the standard option:
Related Articles
Quick Links
Standard Option
Note
The following message is displayed during deployment if the underlying connection configurations are not
correct.
To resolve this issue, ensure that the connection configurations are set correctly, and retry. If the problem
persists, contact Customer Support.
Related Articles
The table below provides links to detailed information on the following topics:
Topic Link
https://support.sap.com/content/dam/
launchpad/en_us/pam/pam-essentials/TIP/
PAM_HANA_SDI_2_0.pdf
SDI Documentation
https://help.sap.com/viewer/p/HANA_SMART_DATA_INTE-
GRATION
https://training.sap.com/course/ha350-sap-hana-data-pro-
visioning-classroom-013-us-en/
https://jam4.sapjam.com/groups/
aJfzfCQIIJ2SUHVzjwlg3P/forums?
folder_id=2c1CnFbSGkKWMm2tLSszh7
Related Articles
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.