CX Works

CX Works brings the most relevant leading practices to you.
It is a single portal of curated, field-tested and SAP-verified expertise for SAP Customer Experience solutions

What is Commission Data Loader (CDL) and How to Use It

15 min read

What is Commission Data Loader (CDL) and how to use it

This article talks about Data Integration Options, what is Commissions Data Loader (CDL), how to use CDL for Data Imports using Standard Templates, how to use CDL for Data Imports using Custom Templates and how to use CDL for Data Exports using Custom Templates.

Table of Contents

Requirements

  • FTP Client used to transfer files over internet for example FileZilla Client

  • Access to CDL Dropbox Get Access to CDL Dropbox

  • SAP Commissions URL for example: https://<tenant>.callidusondemand.com/SalesPortal/#!/

Data Integration Options

The below chart gives you different Data Integration Options.

To know more about Data Importing Options, please take a look at Introduction to Data Importing HANA Tools in SAP Commissions

What is Commissions Data Loader (CDL)?

Commissions Data Loader (CDL) is a vital component of the SAP Commissions Application. CDL allows you to securely import and export critical business data to and from the Commissions application, enabling you to easily synchronize and share data within your organization for further processing.

Using CDL, you can import and export data pertaining to the business objects that are defined in Commissions. You can transfer data in bulk, to and from the following workspaces in Commissions:

  • Orders and Transactions workspace for Results

  • Participants, Positions, and Titles workspace for Organization

  • Categories, Products, Customers, and Postal Codes workspace for Classification

Data is typically transferred in Flat File format and the preferred representation is UTF-8 encoding. An Inbound transfer involves exporting/uploading data to Commissions. An Outbound transfer involves extracting/importing data from Commissions.


Understanding Global Settings

Global settings are default settings that apply to both inbound and outbound file transfers.

File type settings defined in Inbound File Type Settings and Outbound File Type Settings override the default Global settings.

To set the default global parameters:

  1. Select Commissions Data Loader from the Apps menu on the top right.

  2. Click Configuration > Global Settings on the left panel and set below parameters.

          


Important Global settings:

  • Compression Mode: Specifies if the files dropped in the outbound folder after import need to be compressed.

  • Charset: Specified encoding attribute to be used in the file, for example: utf-8

  • Delimiter: Specifies the delimiter used to separate data fields, for example: Tab

  • Autorun: When Auto-run is set to Yes, CDL initiates and runs the entire file transfer process, job are automatically run. When Auto-run is set to No, CDL initiates and the process is stopped after the job is created. To resume the transfer process, you can execute the job manually from the Jobs page.

         To understand more about Global Setting: Global Settings


Understanding File Type Settings

File Type settings defines the standard settings and metadata of the file that is imported/exported.

A file type must be configured for each template file, which means every template must have an associated file type. The name of the template must match the file type code and the content must be formatted according to the metadata standards defined in the settings. Unknown file types are not recognized by CDL and will not be processed.

File type settings defined in Inbound File Type Settings and Outbound File Type Settings override the default Global settings.

To set the File type settings:

1.Select Commissions Data Loader from the Apps menu on the top right.

2.Click Configuration > File Type Setup on the left panel.

3.Setup Inbound Settings

   

Important Inbound File settings:

  • Delimiter: Specify the delimiter used to separate the data fields.

  • Calendar Name: Select the required calendar from the list of calendars defined in Commissions.

  • Import Type: Select appropriate Import Type.

  • Proceed with Validation Errors: Set the Proceed With Validation Errors to allow the system to continue to work with data validated on the CDL side.

  • Header: Does the File include column header

To understand more about Inbound File Setting: Inbound File Settings

4.Setup Outbound Settings

Important Outbound File settings:

  • Delimiter: Specify the delimiter used to separate the data fields.

  • Header: Does the File include column header

To understand more about Outbound File Setting: Outbound File Settings


Understanding CDL Jobs

CDL creates a job for every file transfer. You can view the status of the jobs and review the logs on the Jobs page in CDL. The Jobs page lists all the jobs and provides real-time status of the data transfer.

When you log into Commissions Data Loader, the Jobs page is displayed by default. You can perform the following actions using the icons available in the top-right of the page:

  • Upload a CSV, TXT or XML file from your Desktop

  • Execute a job

  • Delete a job

  • Download the Job details

  • Search for specific records

  • Sort and order the records


To understand more about CDL Jobs: CDL Jobs


How to Use CDL to Import Title Data Into Commissions using Standard Templates

In the below example, we will import Title Data into Commission Staging Table.

1. Global Settings

    As discussed in Understanding Global Settings section above, set the necessary Global Settings.

     


2. Inbound File Type Settings

    As discussed in Understanding File Type Settings section above, perform the necessary File Type Settings for the Inbound File Type OGTI

    


3. Download Standard Template for Importing Title Data

   Go to Help->Integrate->Commission Data Loaded (CDL)->CDL Templates->Download Templates for Commissions

   

   

           Or use the link CDL Templates


4. Populate Title Import File

            > Open CDL_OGTI_Template.xlsx file.

            > Review Tab: File Requirements which talks about File naming convention and other file settings.

            > Review Tab: Mapping & Validation which provides you details about Title fields and points out which fields are Mandatory.

            > Use Tab: Template, to populate Mandatory fields along with other necessary Title related data.

            > Save the file keeping in mind, File naming convention and correct delimiter as mentioned in the Global Setting/File Type settings.

             


5. Drop Title Import Data File on the CDL Drop box

   Open FileZilla (FTP Client), establish connection to the CDL Drop box and drop the Title Import file into Inbound Directory of CDL Drop box.

    


6. Check CDL Job Page and Start Job

  After few minutes of dropping the file on to CDL Drop box, a background job picks up and will create a CDL Job.

  

  As you see, the Job Status is Created, this is because Autorun Global Setting was set to False.

  To execute the Job, select the Job and click on Execute.

   


7. Check Job Status and Check for Failures

   Once the Job is completed successfully, Status should be updated to Success and will show the number of records in the Successes column.

   


   In case there were any issues with the records, Status would be updated to Failure and will show how many records were Successful and how many records failed.

   


   To check errors, click on the number in the Failures Column and a Zip file will be downloaded. Open the .log file and you will get more details on which records failed and why it failed.

   

   In the above example, fix the error record and drop a new file to CDL Drop box and execute the job.


8. Validate Data in Title Staging Table

   From Commissions App, go to Run->Stage Tables, Filter on Tables Name to search all Titles and check if Title data was correctly loaded.

   


How to use CDL to import Title data into Commissions using Custom Templates

In the below example, we will import additional Title Data into a Custom Commission Table (ZCS_PRESTAGETITLE) which will be defined in EXT Schema.

With a HANA Procedure, we will update GENERICNUMBER1 and UNITTYPEFORGENERICNUMBER1 fields of Titles Staging Table (CS_STAGETITLE) Data 

with QUARTERLY_BONUS_QUOTA and UNITTYPE fields from Custom Titles Table (ZCS_PRESTAGETITLE), comparing NAME field in both the tables.

1. Create Custom Table in EXT Schema

   Using WebIDE, create a table called ZCS_PRESTAGETITLE in the EXT Schema

  

2. Global Settings

    As discussed in the Understanding Global Settings section above,  set the necessary Global Settings.

3. Inbound File Type Settings

   From Commission Data Loader app, go to File Type Settings and click on Create and enter below details.

   

    Type                                   : Inbound

    File Type Name                 : ZOGTI (File Type Name should be Unique)

    Target                                : EXT Table Name

    Target Stored Procedure : HANA EXT Procedure   

    

HANA Procedure is not mandatory, If you don't provide any Procedure name, then once the data gets imported, it will reside in Target Table.

             

4. Create HANA Procedure

   Using WebIDE, create a HANA Procedure in EXT Schema

   


5. Populate Custom Title Import File

            Populate Mandatory fields along with other fields and save the file, considering File naming convention and correct delimiter as mentioned in the Global Setting/File Type settings.

            

           

6. Drop Title Import data file on the CDL Drop box

    Follow same steps as mentioned above in Drop Title Input Data File into the CDL Drop Box to drop the file on the CDL Drop box:

    Open FileZilla (FTP Client), establish connection to the CDL Drop box and drop the Title Import file into Inbound Directory of CDL Drop box.

7. Check CDL Job Page and Start Job

   Follow same steps as mentioned above in Check CDL Job Page and Start Job.

   

  

8. Check Job Status and Check for Failures

    Follow same steps as mentioned above in Check Job Status and Check for Failures.

   

   

9. Validate Titles Staging Table Data

   From Commissions App, go to Run->Stage Tables, Filter on Tables Name to search all Titles and check if Title data has been correctly updated.

   


How to use CDL to export Monthly Credit data from Commissions using Custom Templates

In the below example, we will export Monthly Credit details for a Pipelinerun from Commissions EXT table into a flat file.

With a HANA Procedure, we will update the EXT Table contents and transfer the table contents to a flat file.


1. Create Custom Table in EXT Schema

    Using WebIDE, create a table called ZCS_EXPORTPERIODCREDIT in the EXT Schema

    

2. Global Settings

    As discussed in the Understanding Global Settings section above,  set necessary Global Settings.

3. Outbound File Type Settings

    From Commission Data Loader app, go to File Type Settings and click on Create and enter below details.

    

    Type                                   : Outbound

    File Type Name                 : ZPERIODCREDITEXTRACT (File Type Name should be Unique)

    Source                                : EXT Table Name

    Source Stored Procedure : HANA EXT Procedure   

                

4. Create HANA Procedure

    Using WebIDE, create a HANA Procedure in EXT Schema

    


5. Run Outbound File Type during Pipeline Processing

    During the Pipeline execution, choose Data Extracts option an d Provide Outbound File Type Name.

         

    

To run the Outbound File Type from a Trigger File, please refer to Perform an Outbound Transfer

             

6. Check CDL Job Page and Start Job

    Follow same steps as mentioned above in Check CDL Job Page and Start Job.

    

  

7. Check Job Status and Check for Failures

    Follow same steps as mentioned above in Check Job Status and Check for Failures.

    

   

8. Validate Data Extracted

    Using WebIDE, check  EXT Table ZCS_EXPORTPERIODCREDIT to see if HANA Procedure populated Credit Data for the Pipeline Period.

   


    From CDL Drop box, verify if a new file has been created in Outbound folder and has same entries as in EXT Table ZCS_EXPORTPERIODCREDIT

    

    Verify File Contents

    


.






Conclusion

By end of this article, you should be able to do the following:

  • Understand Commission Data Loader (CDL)
  • How to Import data using Standard Templates
  • How to Import data using Custom Templates
  • How to Export data using Custom Templates
Overlay