Data Integration

Objectives
After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Determine the best data integration option for an implementation
  • Configure an integration scenario using Commissions Data Loader (CDL)
  • Upload data using Commissions Data Loader (CDL)
  • Use the validate and transfer pipeline task to import data from staging to production
  • Purge import data
  • Extract payment data from SAP Commissions using Commissions Data Loader (CDL)

Options for Data Integration

Typically, the data used to calculate compensation originates in various source systems outside of SAP Commissions. The Data Integration process is used to ensure that this data is property mapped and updated regularly before each calculation is run.

For example, payees enter their sales transactions into a CRM tool. The transaction data is integrated into SAP Commissions, where the payments are then calculated.

When using most data integration options, inbound data moves to a series of staging tables.

SAP Commissions Data Integration Solutions

Data Integration SolutionsExcel Data LoadersCommissions Data Loader (CDL)Smart Data Integration (SDI)SAP Cloud Platform IntegrationREST API
Use CaseAd Hoc data importsSmall to Medium Sized organizationsLarge enterprise organizations, 3rd party source dataLarget enterprise organizations, primarily SAP source dataCustom API client
User TypeBusiness

Business or Technical

Technical

Technical

Technical

FrequencyAd Hoc

Ad Hoc or scheduled drop

Scheduled or real-time

Scheduled or real-time

Real-Time

Data Volume< 1,000 rowsUp to 5 Million rows or 1 GB data per drop fileHigher Volume than CDL

1,000 to 100,000 rows

< 1,000 rows per call

Data TransformationsNoneHANA stored proceduresFlowgraph based transformations

Integration

flow-based transformations

None
ConnectorsNoneNoneIn-built adapters / connectors for source systems

SAP Cloud Platform marketplace

None

LicenseIncluded in Core CommissionsIncluded in Core CommissionsIncluded in Core CommissionsAvailable through SAP Cloud Platform

Included in Core Commission

  • Excel Data Loaders are used for ad hoc data loads on the user level. It is not designed for high volume data transfers.
  • The Commissions Data Loader is an ideal solution for small to medium-sized businesses. This tool is included with SAP Commissions and uses a secure dropbox to load high volumes of data. The data transfer is completed with HANA procedures.
  • Smart Data Integration (SDI) is designed for high data volume and data transformation. It uses Web IDE, a graphical tool, to define flowgraphs for data transformations. SDI requires technical expertise to accomplish data integrations.
  • SAP Cloud Platform Integration (CPI) connects applications to transfer data from one system to another through the cloud. CPI is available through SAP Cloud Platform.
  • REST APIs are new configured APIs. Typically, APIs are used for smaller volumes of data, with real-time integration.

Exercise: Import Organization Data and Transaction Data

Business Example

In this exercise, you will use the instructions below to import Organization Data and Transactions into Commissions. You will use this transaction data to build a compensation plan throughout this course.

Steps

  1. Import Organization Data

    1. Select the Participants icon in the Manage Organization tile.

    2. Select the Upload Excel Data icon on the toolbar.

    3. Select Choose File.

    4. Select the BikesInMotion Organization Data.xlsx file.

    5. Select Upload Excel Data.

    6. When the import is complete select the Quick Search icon to refresh the workspace.

  2. Import transaction data.

    1. Return to the home screen and selectCalculations - Transactions in the Review Calculations tile.

    2. Select the Upload Excel Data icon on the toolbar.

    3. Select Choose File.

    4. Select the BikesInMotion Transaction Data.xlsx file.

    5. Select Upload Excel Data.

    6. When the import is complete select the Quick Search icon to refresh the workspace.

  3. Import Classification data

    1. On the home screen, select Plan Data - Classification icon in the Manage Plans tile.

    2. Select the Upload Excel Data icon on the toolbar.

    3. Select Choose File.

    4. Select the BikesInMotion Transaction Data.xlsx file.

    5. Select Upload Excel Data.

    6. When the import is complete select the Quick Search icon to refresh the workspace.

Configuring an Integration Scenario Using Commissions Data Loader (CDL)

Commissions Data Loader (CDL) is a cloud-based tool that allows you to securely import and export data to and from SAP Commissions without the need for coding. CDL enables the compensation team to synchronize data with SAP Commissions.

CDL can be used to import data, such as Transactions or Payees, from the CRM, or Product Data from the ERP system. You can also use CDL to export data, such as payout data, to a payroll system or provider.

Global and file type settings

To start using Commissions Data Loader, the first step is to configure file requirements. This had three steps: global settings, inbound file type settings, and outbound file type settings.

Global settings are default settings that apply to both inbound and outbound file transfers. Global settings include such options as the default time zone, character encoding, compression type, and the email recipient for success and failure notifications.

Inbound file type settings include the standard settings and metadata of each file that is imported. A file type must be configured for each template file, which means that every template must have an associated file type. Settings include the file type, import options, and target staging table. You can also override the default character set and delimiter by setting these in the file type settings.

Outbound file type settings include the standard settings and metadata of each file that is exported, such as payment data. Settings include the outbound file type, source stored procedure, and compression mode. As with inbound file type settings, you can override the default character set and delimiter by setting these in the file type settings.

CDL Global Settings

CDL File Type Settings

To configure global settings:

  1. From the application picker, select Commissions Data Loader.
  2. Select Configuration – Global Settings.
  3. Set the compression mode. The default is Gzip.
  4. Set the time zone. This is used for the timestamp on the job.
  5. Select a character encoding attribute (Charset). The default is UTF-8.
  6. Select a delimiter. The default is tab delimited.
  7. Select a retention period for error logs and jobs. The defaults are 30 days and 90 days, respectively.
  8. Enter an email for notification of success and failure emails.
  9. Using the Autorun switch, indicate whether the import should run automatically once the file upload is executed.
  10. Select an escape delimiter. This setting specifies if comma separated files which have a delimiter as part of its data can be loaded. When this option is enabled, you can use double quotation marks for importing values which have a delimiter as part of the field ("").
  11. Select Save.

To configure inbound file type settings:

  1. Select Configuration – File Type Setup.
  2. Scroll or search for the file type. The example below shows the setup for sales transactions.
  3. Select a character encoding attribute (Charset) or leave it at the global default.
  4. Select a delimiter or leave it at the global default.
  5. Select an import type. More information on import types is covered in the next topic.
  6. Select the switch to proceed with an import if errors are found in validation.
  7. Select the Header switch if your data file has headers.

Configure global and file settings

  1. From the Application picker, select Commissions Data Loader.

    Commissions Data Loader will open in a new tab.

  2. Update the Global Settings.
    1. Select the Configuration icon.
    2. Select Global Settings.
    3. Update the fields in the dialog box as shown:
      • Compression Mode: Gzip
      • Time Zone: Any
      • Charset: Utf-8
      • Delimiter: Tab
      • Success Emails Recipient: admin.user@email.com
      • Failure Emails Recipient: admin.user@email.com
      Note
      Optionally, use your own email for the email recipients to see what the emails look like.
      • Autorun: No
      • Escape Delimiter: Yes
  3. Select Save.

Uploading Data Using Commissions Data Loader (CDL)

Various templates are provided to upload data to Commissions. Each template is specific to an inbound file type and relates to a Commissions business object. All the templates are in .xls format and are available as a downloadable .zip file. They can be downloaded from the online help here.

The following video shows how to find and download the CDL templates, how to populate the templates, and how to name and save them using the naming convention.

Once the templates are in place, it’s time to upload the data to SAP Commissions. This is done from the Jobs tab in CDL.

Exercise: Uploading Transactions using Commissions Data Loader

Validate and Transfer

When loading data from external sources, stage tables help us validate the data before it is moved into the production tables. It also provides an opportunity to back data out of the system, if we see any problems.

The stage tables can be found under Review Calculations – Run – Stage Tables.

The Validate and Transfer process can be initiated from Commissions Data Loader, or it can be run independently after the data is loaded. A Validate and Transfer process is initated as a Pipeline task by selecting the Import Data from Stage task.

The easiest way to initiate a Validate and Transfer task is to select the Import Type option during the File Type Setup in Commissions Data Loader. Setting the Import Type to None will not run Validate and Transfer. Other Import Type options are Validate, Validate and Transfer, and Validate and Transfer if All Valid.

Purging Data

Once stage data has been imported, there is often no need to keep it in the stage tables. Therefore, it’s a good idea to regularly purge data from the stage tables. Purging data has two advantages: it increases performance of the CDL data upload process, and it reduces the amount of stored data.

Data can be purged in the SAP Commissions user interface or by using Commissions Data Loader.

Learn more in this blog post.

Using Commissions Data Loader to Extract Payments

In addition to uploading data from source systems, Commissions Data Loader can also be configured to extract payment data for integration with payroll and accounts payable systems. This has the added advantage of allowing the administrator to customize the output to meet the needs of the target system.

Before creating an outbound configuration, the user should have access to the following:

  • Permission to run a Pipeline
  • A file explorer that allows a connection to the tenant database, such as WebIDE, Hana Studio, or Eclipse
  • The ability to create Custom Tables and Custom Stored Procedures on the tenant database
  • If using Secure FTP for the file transfer, access to the Outbound folder on SFTP dropbox
  • RestAPI v2 and Odata API Access for debugging

To create an outbound configuration in Commissions Data Loader:

  • Using WebIDE or another HANA database access application, create a custom table containing the attributes to extract. For this example, this table will be called PAYMENTEXTRACT.
  • Create a stored procedure to extract the data. For this example, the stored procedure will be called EXTRACTPAYMENTS.
  • Go to Configuration – File Type Setup and create an extract configuration.
  • Select the Outbound tab
  • Create a new File Type using the + sign on the Toolbar
  • In the Create New File Type dialog box:

    • Set the type to Outbound
    • Enter the source PAYMENTEXTRACT
    • Enter an optional description
    • Enter the output file type txt
    • Enter the source PAYMENTEXTRACT
    • Enter the Source Stored Procedure EXTRACTPAYMENTS
    • Leave the Compression Mode at the default
    • Set the Character set (Charset) to Utf-8
    • Set the delimiter to Tab
    • Set the Header switch to Yes
  • Run a Pipeline for the Data Extract Stage. For the Data Extract, enter the name of the custom table. In this example, we use PAYMENTEXTRACT.

Learn more about outbound file transfers in this blog post.

Best Practices for Data Integration

  • Excel Data Loaders are used for ad hoc data loads on the end user level. It is not designed for high volume data transfers.
  • The Commissions Data Loader is an ideal solution for small to medium sized businesses. This tool is included with SAP Commissions and uses a graphical user interface to upload high volumes of data.
  • Smart Data Integration (SDI) is designed for high data volume and data transformation. It uses Web IDE, a graphical tool, used to define flowgraphs for data transformations.

Save progress to your learning plan by logging in or creating an account

Login or Register