Express Data Loader Setup
Express Data Loader Setup
2.3 Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Troubleshoot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
End-User
Administrator
Express Data Loader is a vital component of SAP SuccessFactors Incentive Management. Express Data Loader
allows you to securely import and export critical business data to and from Incentive Management, enabling
you to easily synchronize and share data within your organization for further processing.
Using Express Data Loader, you can import and export data pertaining to the business objects that are defined
in Incentive Management. You can transfer data in bulk, to and from the following workspaces in Incentive
Management:
Data is typically transferred in Flat File format and the preferred representation is UTF-8 encoding. An
Inbound transfer involves exporting/uploading data to Incentive Management. An Outbound transfer involves
extracting/importing data from Incentive Management.
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.
Express Data Loader is accessible from the applications menu in SAP SuccessFactors Incentive Management.
See Accessing Express Data Loader [page 13] for details.
Related Topics
Express Data Loader supports integration with SAP Territory and Quota.
SAP SuccessFactors Territory and Quota objects can be loaded into Express Data Loader in the same manner
SAP SuccessFactors Incentive Management objects are loaded. Data can be exported to the following SAP
SuccessFactors Territory and Quota workspaces:
• Account
• Territory Account
• Geography
• Territory Geography
• Territory Product
• History (Transaction Summary)
• CRMOpportunities
To export SAP SuccessFactors Territory and Quota data, you must perform an inbound transfer using the SAP
SuccessFactors Territory and Quota file type templates. The templates for SAP SuccessFactors Territory and
Quota file types are downloadable from Express Data Loader Templates [page 28].
For a successful inbound transfer, data must be filled out in a flat-file format using the provided templates and
must comply with the required formatting, mapping, and naming conventions.
Related Articles
2.3 Glossary
Term Definition
Incentive Management Stage Tables Temporary data storage area in Incentive Management
where data from Express Data Loader is placed during ex-
port. Data is validated in the staging area before transferring
into the Incentive Management tables and executing the
pipeline. See Incentive Management Administrator online
help for more details.
Express Data Loader Job Each file that is transferred in an inbound or outbound trans-
fer.
Custom Inbound Custom Inbound allows you to load ad-hoc data from a file to
a temporary table, then invokes a HANA stored procedure to
transfer data from the temp tables to Incentive Management
stage tables, and finally imports data to the Incentive Man-
agement tables through Incentive Management stage data
import.
Express Data Loader Secure Box Express Data Loader Inbound and outbound folders which
are accessible using SFTP. Exported files are dropped off in
the inbound folder and imported files are available for pick
up in the outbound folder.
Incentive Management Relational Import Relational import provides the ability to validate Incentive
Management objects such as transaction data, organization
data, classification data, and so on for data transfer. These
objects are often prerequisite data that must be in store
when you run compensation processing jobs.
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.
This section describes how to set up and use Express Data Loader.
Installation
Configuration
Data Transfer
You must install and set up the SFTP Client and GPG Encryption component before you begin file transfers.
Related Topics
The following figure illustrates the Express Data Loader architecture and describes the data transfer process.
The Express Data Loader data transfer infrastructure uses secure FTP (SFTP) protocols and related toolsets
to optimize the security and maintenance of the file transfer accounts and processes. The SFTP server is
configured to allow only secure FTP, exclusively from the customer’s external IP. All Shell access or other
protocols are blocked by the firewall policy.
In the case of inbound transfers, once the files are dropped off in the Inbound folder (Express Data Loader
Secure Box) using SFTP, the File Management solution checks if the uploaded files are encrypted and encrypts
the files if not encrypted. The File Management solution then performs various checks for template compliance
and routes the files to the Inbound NFS Mount folder for pick up.
Once validations are complete, data is loaded into the corresponding staging tables in the HANA repository
and then into the Incentive Management database after various functional validations are performed through
Relational Import. When the file transfer process is completed, Express Data Loader checks the status of the
jobs and notifies the user who initiated the transfer, if the data has been successfully transferred. Details
about the transfer, including time, event, status (success or failure) and error logs are refreshed and accessible
through Express Data Loader during the entire process.
Note
Express Data Loader creates a job for each file that is being transferred and runs the data transfer process
for each file. In the case of paired files, Express Data Loader identifies the dependent files and processes
the files once all the dependent files are dropped. Pipeline Import is triggered only for parent file types.
In outbound transfers, files are routed to the outbound NFS Mount folder and then dropped off into
the outbound folder (Express Data Loader Secure Box). The extracted files can be downloaded from the
customer’s FTP site. Email notifications are sent out when the data transfer is complete.
BusinessObjects
BusinessObjects is a component of Express Data Loader which maintains user group data. Express Data
Loader interacts with BO and Incentive Management to sync user groups in the BO repository when the
following BO templates are dropped for data transfer:
• BOTRIG (Inbound transfer): Once the empty file is dropped, Express Data Loader identifies the BOTRIG
file and communicates with Incentive Management (Participant Object), and obtains the user ID and label
which has the group data, and syncs the details in BO.
• BOUPDATE (Inbound transfer): Express Data Loader connects to BO, associates or disassociates users to
the group accordingly, and updates the BO repository. Data is picked up from the updated BO repository
when reports are generated in Incentive Management.
• BOEXTRACT (Outbound transfer): Express Data Loader extracts user group data and populates the flat
files.
For more details, refer Incentive Management and BusinessObjects User Group Association [page 50].
Related Topics
Secure File Transfer Protocol (SFTP) allows you to securely transfer your data over the network.
Procedure
1. Download and install the SSH/SFTP Client. Express Data Loader works with any standard SSH/SFTP client
application. The most commonly used free SSH/SFTP client for Windows is WinSCP. You can download
and install WinSCP from https://winscp.net/eng/download.php. To illustrate a typical client setup process,
WinSCP is used as an example in this documentation.
2. Generate a SSH Public/Private key pair in your SSH client. For example, in WinSCP client, PuTTYgen is
used to generate the SSH2 key. We support setting SSH 2 (RSA) to 4096 bit.
3. Associate the key pair with your email address to help you identify the key later on. For example, in WinSCP
client, you can specify your email address in Key Comment
4. Save the public and private key pair. Specify a file name for the public and private key and save the key files
in the same location. We recommend that you save the key files in a location that you can easily find later.
5. Open the Public SSH2 key file using any text editor and copy the public key. Send support the public
key by logging a ticket. Your ticket must also include information about the customer tenant id you will
be connecting to. Our technical operations team will install your public key in the Secure Box and give
you access to your SFTP Dropbox (via a support ticket). You will then receive details about the SFTP File
Protocol, Hostname, Port, and Username from the technical operations team.
6. To perform file transfers, log in to your SFTP Dropbox using the credentials provided by the operations
team. When connecting to SFTP, you must provide the private key for authentication. For example, in
WinSCP, the private key is updated in Advanced Settings > Manage > Edit option > Private Key File.
The public key you send us will look something like this:
Comment: "username@ondemandcustomer.com"
ABCDEF3NzaC1yc2EAAAABJQAAAIEAjcaNa1aKHus3o2+8laFMbZEaFm8qCPBhLddD
lx4QzdoIooTGU/soG0OK2QLouy99Ef+KKYvMaQzWZJjaqPMh+sM4S3kwWlRXzv+p
gP7ZKcmClxYM56ec9bSu2gva+ViR8gke7eLaML+/A+ZAXdLcOU0iK8qSHsajMhzo
5s9unX8=
Related Topics
GNU Privacy Guard (GPG) is an encryption tool that secures your data by encrypting it so that only intended
individuals can read it. As part of our security policy, we recommend that you encrypt the files before
dropping the files in the inbound folder for export. However, if the files are not encrypted, Express Data Loader
automatically encrypts the files through the File Management System, but you will not be able to view the
encrypted files since the processing is done internally in Express Data Loader.
Procedure
1. Download and install GPG on your computer.You can download the GPG tool from https://gnupg.org/
download/. Refer to the documentation included with GPG for complete installation instructions.
2. Generate the GPG key pair and exchange the GPG keys.A GPG key pair is composed of a private key to
which only you have access and a public key that you need to send us in a support ticket. The public key will
be used to send encrypted files. To decrypt encrypted the files you receive from us, we will send you our
public key which you can use to decrypt the encrypted files. Contact support for more details.
Related Topics
Inbound Folder
The Inbound folder contains the files that you drop off for upload. Express Data Loader supports the following
file types:
Files are moved to the archive folder immediately after processing is complete.
Outbound Folder
The Outbound folder contains encrypted and zipped files that are dropped off for you to download. The files
are suffixed with a .gpg extension. Optionally, you can choose to zip the files by enabling compression in the
Express Data Loader user interface.
Files remain in the folder for the agreed duration (retention period). Files are automatically deleted post
retention period to comply with GDPR standards. As a best practice, delete the files after download is
complete.
Archive Folder
The Archive folder contains files that are moved from the inbound folder after processing is complete. Files
are moved to the archive folder immediately after processing. Files are moved even if data validation errors are
detected and the transfer is not successful.
If plain files are dropped, Express Data Loader encrypts the files and archives the encrypted files after
processing is complete.
The Bad Files folder contains files that are rejected if an invalid character (special character) is present in the
file. This folder also contains the files that are re-dropped for upload, while the same set of files that were
previously uploaded are still being processed.
Related Topics
In the Apps drop-down, choose Express Data Loader to access the Express Data Loader application.
Note
You must have administrator rights and appropriate permission settings to access and use Express
Data Loader. If you have questions about your login credentials and permission settings, contact your
administrator.
Related Topics
The Configuration menu in Express Data Loader provides various options to fully customize the operational
settings of the data loader. Configure the following settings to meet your specific business requirements:
Global settings are default settings that apply to both inbound and outbound file transfers.
Note
File type settings defined in Inbound File Type Settings [page 16] and Outbound File Type Settings [page
20] override the default Global Settings.
Procedure
1. Select Express Data Loader from the Apps menu on the top right.
2. Click Configuration > Global Settings on the left panel and set the following parameters.
Parameter Description
Compression Mode
Specify if the files dropped off in the outbound folder after
import must be compressed:
Timezone Specify the default time zone. The timestamp on the Jobs
page displays the specified timezone.
Retention Period for Errors (Days) Specify the retention period in days for error logs. The error
log files will be deleted after the specified period.
Retention Period for Jobs (Days) Specify the retention period in days for jobs. Each file trans-
fer is a job. All outbound jobs will be deleted after the speci-
fied period. Jobs from the Jobs page are also deleted post
retention period.
Success Emails Recipient Specify the email address to which all notifications about
successful file transfers must be routed. You can enter multi-
ple email addresses separated by comma.
Failure Emails Recipient Specify the email address to which all notifications about
failed file transfers must be routed. You can enter multiple
email addresses separated by a comma.
Incentive Management Portal Connection Click Test to check the connection to the Incentive Manage-
ment Portal tenant.
Business Object Connection Click Test to check the Business Object connection.
Escape Delimiter Specify if CSV 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/column ("").
Note
Retention period is a GDPR standard. The retention period is the duration after which, the respective
information and records will be deleted from our servers. You will not be able to retrieve the deleted data.
Check with your organization about the preferred retention period.
Related Topics
An inbound file type defines the standard settings and metadata of the file that is exported. A file type must be
configured for each template file that is exported, which means that, 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 Express
Data Loader and will not be processed.
Note
The Inbound File Type settings override the Global Settings [page 14].
Procedure
1. Select Express Data Loader from the Apps menu on the top right.
2. Choose Configuration > File Type Setup > Inbound. This page lists existing inbound file types, if any.
• Edit: Edits the configuration details of an inbound file type. Select the file type and click the Edit icon.
• Reset: Resets the configuration to default settings. This option is only available for Standard File Types.
When you reset configuration settings for an inbound file type, it impacts all new inbound transfers. The
jobs that are already in progress continue to use the old configuration settings.
• Delete: Deletes an inbound file type. This option is available only for Custom File types. You cannot delete a
file type when files that are being processed correspond to the file type. However, you can delete a file type
when it is not used.
• Refresh: Refreshes the page.
• Sort: Sorts the column display.
• Search: Filters the records based on the search key.
• Import/Export: Enables code migration for deployment [page 25].
• Create: Enables you to configure a new inbound file type. Click the Create icon and enter the following
details to create a new inbound file type:
Parameter Description
Type This is the export file type. Every template must have an
associated file type. The file type cannot be a duplicate.
File Type Name Enter a name for the inbound file type. The name is a four-
letter code that is used to identify the file type. See File Type
Codes and Staging Tables for list of File Type Codes.
Target Stored Procedure This applies to custom inbounds and is used to allow a
HANA procedure to be called after the data is loaded into
the Hana custom table.
Calendar Name Select the required calendar from the list of calendars de-
fined in Incentive Management.
Proceed With Validation Errors Set the Proceed With Validation Errors to allow the system
to continue to work with data validated on the Express Data
Loader side.
If you do not set this option, the system will proceed after
Express Data Loader validation only if all data is valid. For
invalid data, the Job will finish with Failure status. This option
is applicable to all file types except dependent file types.
Territory data can also be loaded into Incentive Management via Express Data Loader. When Express Data
Loader detects a XML file for Territory in the Inbound folder, Express Data Loader imports the Territory data
into the Incentive Management table, without using staging tables.
Territory data import is performed through Territory Standard File Type. The File Type Name and File Type
Description for the Territory Standard File Type is defined in Configuration > File Type Setting > Inbound File
Type.
Note
A sample Territory XML file can be exported from Incentive Management using the XML loader to view the
structure of the XML file for import.
Related Topics
For custom file types, you can create dependent file types and execute the dependent file types based on the
processing order specified in Configuration > File Type Setting > Inbound File Type > Dependent File Type.
An outbound file type defines the standard settings and metadata of the file that is imported. Data is extracted
in flat file format and contains all columns used in the specific workspace. File type settings for every outbound
file must be defined.
Note
The Outbound File Type settings override the Global Settings [page 14].
Procedure
1. Select Express Data Loader from the Apps menu on the top right.
2. Click Configuration > File Type Setup > Outbound. This page lists existing outbound file types if any.
The following options are available on the top-right corner of the page:
• Edit: Updates the configuration details of an outbound file type. Select a file type and click the edit icon.
• Delete: Deletes an inbound file type. This option is available only for Custom File Types. You can delete a
file type only when it is not used.
• Reset: Resets configuration details to default settings. This option is only available for Standard File Types.
When you reset configuration settings for an outbound file type, it impacts all new outbound transfers. The
transfers that are already in progress continue to use the old configuration settings.
• Refresh: Refreshes the page.
• Search: Filters the records based on the search key.
• Sort: Sorts the column display.
• Import/Export: Enables code migration for deployment [page 25].
• Create: Enables you to configure a new outbound file type. Click the Create icon and enter the following
details to create a new outbound file type:
Source Type
Select the appropriate Source Type:
File Type Name This is the import file type. Enter a name for the outbound
file type. The name is a four letter code that is used to iden-
tify the file type. See File Type Codes and Associated Staging
Tables [page 22]for list of staging tables.
Source Stored Procedure Specify the HANA procedure to use to load data into Source
table. Data will be extracted to the outbound file from this
Source table.
Compression Mode
Specify if the files dropped off in the outbound folder after
import must be compressed:
The following table lists all the file type codes and the associated staging tables currently supported by Express
Data Loader.
Note
To avoid performance issues, make sure to clean up data periodically from the stage tables and the
dependent stage tables, especially if the volume is approaching a billion records. For more information,
please contact the support team.
File Type Code Dependency File Type Stage Tables Dependent Stage Tables
Incentive Management
CLCA CS_STAGECATEGORY
CLCC CS_STAGECATE-
GORY_CLASSIFIERS
TXCR CS_STAGECREDIT
CS_STAGECUSTOMER
CLCU
TXDE CS_STAGEDEPOSIT
PLFV CS_STAGEFIXEDVALUE
FVVAMON CS_STAGEFIXEDVALUE
FVVAQTR CS_STAGEVARIABLEAS-
SIGNMENT
OGPT CS_STAGEPARTICIPANT
OGPO CS_STAGEPOSITION
CLGC CS_STAGEGENERICCLASSI-
FIER
PLMC CS_STAGEMDLTCELL
TXOH CS_STAGESALESORDER
OGPR CS_STAGEPOSITIONRELA-
TION
CLPC CS_STAGEPOSTALCODE
CLPR CS_STAGEPRODUCT
PLQU CS_STAGEQUOTA
CS_STAGETITLE
OGTI
TXST CS_STAGESALESTRANSAC-
TION
CS_STAGEVARIABLEAS-
PLVA
SIGNMENT
No link to DB table
PIPELINE
TQAC CSQ_STAGEACCOUNT
TQGEO CSQ_STAGEGEOGRAPHY
TQTGEO
CSQ_STAGETERRITORY-
GEOGRAPHY
TQGEOVAL CSQ_STAGEGEOGRAPHY-
VALUE
TQTAC CSQ_STAGETERRITORYAC-
COUNT
TQTPR CSQ_STAGETERRITORY-
PRODUCT
TQHIS CSQ_STAGETXNSUMMARY
TQCRMOP CSQ_STAGECRMOPPORTU-
NITIES
TQTP CSQ_STAGETERRITORY-
PROGRAM
TQTERR CSQ_STAGETERRITORY
TQTPOS CSQ_STAGETERRITORYPO-
SITION
TQTQUOTA CSQ_STAGETERRITORY-
QUOTA
TQTRAP CSQ_STAGERULEALIGN-
MENTPROPERTY
Note
Generic Date Fields support only Dates. Time Stamp is truncated during import.
Related Topics
An option to facilitate deployment via import or export of data objects in XML is provided in Express
Data Loader. The XML file contains the Global Settings defined in Express Data Loader and the File Type
Configurations for selected File Types.
• To export data objects, select theFile Types to export and then click the Export icon on the top right of the
page.
During import, the system checks if the file types that are being imported already exist in the system and
displays a list of the existing file types. You can choose to override (update) or retain the existing file types.
Related Topics
Quick Links
Inbound Transfers
An inbound transfer involves exporting data to SAP SuccessFactors Incentive Management. For a successful
inbound transfer, data must be filled out in a flat file format using the provided Excel templates and must
comply with the required formatting, mapping, and naming conventions. Once the templates are dropped off in
the inbound folder of the SFTP Dropbox, Express Data Loader reads and loads the data into the system, moves
the files to the archived folder, and sends success or failure notification emails accordingly.
Note
Recommended file size for standard inbound jobs is 2GB. This applies to zip, plain, or encrypted file types.
As part of our security policy, it is recommended that you encrypt the files before dropping the files in the
inbound folder for export. See GPG Encryption [page 11] for details.
Express Data Loader supports the following file types for Inbound transfer:
Note
You can also upload a CSV, TXT or XML file from your local desktop. See for more details. [page 37]
Outbound Transfers
An outbound file transfer involves extracting data from SAP SuccessFactors Incentive Management. The
extracted data is in a flat file format and is placed in the designated outbound folder of the SFTP Dropbox.
Note
Recommended file size for standard outbound jobs is 2GB. This applies to zip, plain, or encrypted file types.
It is recommended to zip files in .gzip format for better speed when copying files with larger number of
records.
You will be notified by email when the outbound transfer is complete and the files are ready for pick up. The
email contains details of the data transfer and an automatically generated summary of the contents. Extracted
files can be picked from the outbound folder in the same SFTP Dropbox. Files are retained in the outbound
folder for the duration specified in the retention period.
Express Data Loader supports the following file types for Outbound transfer:
Note
Related Topics
Various templates are provided to upload data to SAP SuccessFactors Incentive Management and SAP
SuccessFactors Territory and Quota. Each template is specific to an inbound file type and relates to a business
object in the respective applications.
All the templates are in .xls format and are available as a downloadable .zip file:
Note
The columns in the excel template match the columns available in the application. Ensure that the
templates are filled out according to the specified guidelines.
The following table lists and describes all the available templates.
Incentive Management
CLCC_Template CLCC
This template captures information
about Category Classifier.
TXCR_Template TXCR
This template captures information
about Credit.
CLCU_Template CLCU
This template captures information
about Customer.
TXDE_Template TXDE
This template captures information
about Deposit.
PLFV_Template PLFV
This template captures information
about Fixed Value.
OGPO_Template OGPO
This template captures information
about Position.
OGPT_Template OGPT
This template captures information
about Participant.
CLGC_Template CLGC
This template captures information
about Generic Classifier.
TXOH_Template TXOH
This template captures information
about Order.
OGPR_Template OGPR
This template captures information
about Position Relation.
CLPC_Template CLPC
This template captures information
about Postal Code.
CLPR_Template CLPR
This template captures information
about Product.
TXST_Template
TXST This template captures information
about Transaction.
TXSTG_Template TXSTG
This template captures information
about Transaction.
Related Topics
• Use the templates provided by our operations team to export data. See Express Data Loader Templates
[page 28].
• Follow the guidelines to fill out data in the templates. Files must be formatted to meet the staging table
specifications.
• Follow the formatting and mapping conventions defined in Inbound File Type Settings [page 16].
• Ensure the following naming convention is used for the file:
CCCC_TTTT_III_YYYYMMDD_SSSSSS_[OOOOOO].[file type].[compression].[gpg]
Value Description
[file type] [Optional] File type suffix. Not critical for processing, but
useful for Operations staff when handling the file. (Example:
*.txt for text, or *.csv for comma-separated)
Example:
Data file CCST_TXST_TST_20060629_01_EU-
SAP1.txt.gz.gpg
Note
The batchname for the following tables is mandatory when loading data:
• CS_GASTAGESALESTRANSACTION
• CS_STAGETRANSACTIONASSIGN
• CS_STAGERASALESTRANSACTION
You must ensure that the batchname is provided when loading data to avoid any interruptions in the data
load process. The batchname should be synchronous, that means, you must use the same batchname
across the parent and the dependent tables.
Pre-requisites
1. Download the required Express Data Loader template. See Express Data Loader Templates [page 28] for
details.
2. Create a flat file using the specifications defined in the template
3. Name the flat file using the specified naming convention for the file type that is dropped. See Inbound File
Transfer Specifications [page 35] for more details.
4. Log in to your SFTP using the SFTP File Protocol, Hostname, Port, and Username credentials provided.
Additionally, you may need to provide the private key for authentication purposes.
5. Drop the files in the inbound folder after you are connected to SFTP.
Once the files are placed in the inbound folder, the data transfer starts immediately. You can view the status of
the file transfer and review the logs in the Express Data Loader user interface.
Note
If Auto-run is set to off, you must manually resume the file transfer process from the Jobs page.
To manually resume a job, click execute in the Jobs page. See Global Settings [page 14]for more
information.
Note
All custom inbounds require one IN parameter where Express Data Loader passes the filename. This can
be utilized by the custom procedure as batchname if required.
3. Select the file you want to upload. Make sure that the file name follows the format
TENANTNAME_FILETYPE_FILENAME and contains only letters, numbers, and underscores. The files
should not be encrypted or zipped.
Related Topics
Pre-requisites
Custom file type should be defined as per the Outbound File Type Settings [page 20].
Perform the following steps to extract data from SAP SuccessFactors Incentive Management:
1. Define the corresponding outbound file type in Outbound File Type Settings [page 20].
2. Create a custom HANA table. This will be the source for the outbound data.
3. Create a custom HANA stored procedure and define the extraction logic within the custom stored
procedure. This will populate the custom table. For the outbound process, you must have the stored
procedure with the OUT parameter of type VARCHAR as the FIRST parameter. Example: Without
Parameters
CREATE PROCEDURE TMP_STAGEPARTICIPANT_NEWSP_NOINPARAMS (OUT FILENAME
varchar(120))
AS
BEGIN
....
END;
Example: With Parameters
CREATE PROCEDURE TMP_STAGEPARTICIPANT_NEWSP_WITHINPARAMS (OUT FILENAME
varchar(120), IN batchName VARCHAR(255))
AS
BEGIN
....
END;
4. To run the outbound file type, drop a trigger file in the inbound folder of the SFTP Dropbox. The trigger file
should have the same file type that is defined in the outbound file type settings [page 20]. Optionally, you
can pass parameters separated by a comma in the trigger file. All parameters are passed in the same order
to the HANA stored procedure. The trigger file initiates the outbound extract job and upon completion, an
outbound extract is generated in the outbound folder of the dropbox.
Note
The OUT parameter is a mandatory parameter. It is used by Express Data Loader to create the file with the
name specified in the OUT parameter. Ensure this field is populated when creating outbound extracts.
SAP SuccessFactors Incentive Management users who also use the SAP SuccessFactors Territory and Quota
solution can now download Territory and Quota object data in bulk (up to 1 million records) from SAP
SuccessFactors Territory and Quota via Express Data Loader.
You can download data of the following SAP SuccessFactors Territory and Quota objects via Express Data
Loader:
The Outbound tab in Express Data Loader displays all the standard outbound file types:
Procedure
To download the object data from SAP SuccessFactors Territory and Quota via Express Data Loader:
Note
The uploaded input file must contain Select and Where strings separated by the Delimiter (Comma).
Note
Fields that you populate in the input file for outbound extract are not case-sensitive. For example,
AccountID, accountid, and ACCOUNTID are all considered as same field.
Refer to this spreadsheet for column-level guidance to the end user for all available SAP Territory and Quota
outbound extracts.
Related Information
Express Data Loader creates a job for every file transfer. You can view the status of the jobs and review the logs
on the Jobs page in Express Data Loader. The Jobs page lists all the jobs and provides real-time status of the
data transfer.
When you access Express 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 [page 37]
• Execute a job
• Delete a job
• Download the Job details
• Search for specific records
• Sort and order the records
Note
Click on the Execute icon to execute the job. This option is available when Autorun is set to No in Global
Settings. The Execute icon is enabled when the job status is CREATED and is disabled after the job is
executed.
The following table describes the details available on the Jobs page.
File Type Displays the four-letter file code associated with the file and
indicates the type of file transferred. For example, TXT im-
plies that the file is related to Transactions and contains
Transaction Data.
Note
Outbound files display a .inprogress extension
when the outbound job is in progress. After the out-
bound job is complete, the extension is removed. The
fully generated file will have the standard extension (.csv
or .txt) once it is downloaded. (This does not apply to
the BOEXTRACTTRIG file type.)
Created Date
Displays the date and time when the files were dropped off
for transfer.
For exported files, it displays the time and date when the
files were dropped off in the inbound folder.
For imported files, it displays the time and date when the
files were dropped off in the outbound folder.
Start Date Displays the date and time Express Data Loader initiated the
data transfer process
End Date Displays the data and time Express Data Loader ended the
data transfer process.
Status
Displays the status of the job.
PIPELINE PROGRESS is visible only on the UI and is displayed instead of PIPELINE TRIGGERED. PIPELINE
PROGRESS displays a progress bar (0-100%) to indicate the progress of the process. This helps you track
the pipeline progress and indicates when the process is complete.
Related Articles
Users are notified about the status of the file transfer via email.
Job status notification emails include an error log if the job contains any failures. You will receive the error log
as an attachment along with the notification email.
Related Articles
3.3.7 Troubleshoot
If a file transfer is unsuccessful due to a validation error, you can resolve the error and drop the file in the
inbound folder again for reprocessing. You can either drop the entire file again or drop a smaller file with only
the corrected records (delta) in the inbound folder.
1. In the Jobs page, click on the number link under Failure and download the corresponding error logs.
2. Check the error description in the log file. The error description indicates the type of error and the related
stage tables.
3. Check the stage tables in Incentive Management for validation issues.
4. Correct the error in the file and drop the entire file or part of the file in the inbound folder for reprocessing.
Note
Files must be dropped into the inbound folder for reprocessing if errors occur during the first run. If you are
unable to resolve the problem, contact SAP Support for further assistance.
The following validations are performed by Express Data Loader during the data transfer process:
• All default field content and structure is validated, including data types, field length, NULL-values, and date
validations in elements that require or do not allow certain values.
Note
Generic Date Fields support only Dates. Time Stamp is truncated during import.
Related Articles
• getJob: /odata.svc/getJob
Prerequisite
You must fetch the access-token through the Portal SSO APIs and pass them as headers:
HEADER
Content-Type:application/json
tenant:AUT1
access-token:77a8fb97-6ac9-429f-80ba-0454cdcd44cc
GET JOB
URL https://<CDL-HOST>/cdl/odata.svc/getJob(fileName='AUT1_PLQU_100_20190121164021.csv')
METHOD GET
-H 'Content-Type: application/json' \
-H 'access-token: 77a8fb97-6ac9-429f-80ba-0454cdcd44cc' \
-H 'tenant: AUT1'
EXECUTE JOB
URL https://<CDL-HOST>/cdl/odata.svc/executeJob
METHOD POST
COMMAND https://<hostname>/cdl/odata.svc/executeJob \
-H 'Content-Type: application/json' \
-H 'access-token: 77a8fb97-6ac9-429f-80ba-0454cdcd44cc' \
-H 'tenant: AUT1' \
• "id": job Id
• "fileName": file name for the data provided/dropped in goAnyWhere
• "fileType": refers to template using for the data to process
• "tenant": tenant id
• "status": current status of the job. possible values(CREATED/WAITING_FOR_DEPENDENT/INPROGRESS/
SUCCESS/FAILURE)
• "startTimestamp": job process start date,
• "endTimestamp": job finished date,
• "totalRecords": total records found in data file,
• "successRecords": total records successfully processed
• "failedRecords": total records failed in job process
• "createdTimestamp": job created date
• "failureReason": reason for job failure. refer error log for clear descriptions
• "fileSize": file size in bytes for the data provided/dropped in goAnyWhere
• "userName": job created by
Related Articles
Quick Links
BusinessObjects (BO) is only used for user groups. When new employees join, or when employees move
between departments, the users need to be assigned appropriate groups in the Incentive Management
application, and then the users need to be synced up with the BO groups, since they are maintained separately
in the BO repository.
The Incentive Management Compensation Administrators are responsible for managing users (participants/
payees) and groups.
To sync user groups with BO groups, the Incentive Management Compensation Administrators must:
1. Add the user group name in a specified format in a participant custom field (GA).
2. Open a ticket with support to get access to the SFTP server, and then drop the files to SFTP. Express Data
Loader picks up the files through an automated process which syncs the users in BO.
3. Run the pipeline to generate reports using the appropriate BO groups and reports. If the sync process is
not completed prior to the report generation stage in the pipeline, the report will not be available for users
in the Incentive Management Reports tab.
Note
By default, all users belong to either the Participant User Group or Admin Group in BO.
BO Reporting Groups
A BusinessObject reporting group allows users (Participants > USERID) to be segregated into smaller chunks
and makes sure only the relevant reports are published for the group of selected users. When a BO group
is created, it is available as an option in Calculation. Select the required reports and the associated group to
publish the reports for the users in the group.
Note
BusinessObject groups are created by the support team. Contact support for more information.
Default BO Groups
By default, the Portal Admin user is the member of the Admin Group and all the Participants are members
of the User Group. The Monaco user who is assigned to Admin Group is automatically added to LDAP and
assigned to a User Group. Open a ticket with support to get the user added to the Admin Group and specify
that the user must be removed from the BO Payee groups.
Custom BO Groups
The default BO groups each contain a list of users (Participants > UserID) and when the group is selected, the
reports are published for the selected group and also to the users under the group. At times, the default BO
Group does not meet the requirements of the implementation, and custom BO Groups can be created. Custom
BO Group allow dividing the user data further into smaller chunks and gives more flexibility on how the reports
should be generated.
Custom BO groups also contain users, like the default BO groups, however unlike the default BO groups, the
users in custom BO groups should be added and removed explicitly as needed, which means when a New
Participant enters the Monaco System or an existing Participant is updated, the Participant’s UserID should
be explicitly added to the appropriate custom BO group. Similarly, when a Participant leaves the system (due
to Termination or other reasons), the Participant’s UserID should be removed from the appropriate custom
BO group. This ensures that the group contains only relevant and active Users and the reports are published
efficiently.
• Data of users and their BO groups (userId, groupName) must be supplied in a flat file with an “add” or
“delete” operation (“add” user to group or “remove” user from group) and dropped in the Inbound folder.
• The content must be tab delimited with double quotes enclosing each data item.
• The BOUPDATE file naming convention must be followed. Example:
<TENANTID>_BOUPDATE_PRD_YYYYMMDD.
Example:
This operation can be automated in the inbound pre-processing and based on the incoming Participants; the
above file can be created and dropped in the folder to maintain the users in the groups.
BO supports sequencing of the user data in the appropriate usergroups in BO. The size of the sequencing
is defined in the property file.
1. In this method, a GENERICATTRIBUTE of the CS_PARTICIPANT table is selected to store the BO Group.
This GA should then be enabled as follows in Monaco:
1. Go to Administration > Customization > Organization > Participants.
2. Check the Active box for one of the Generic Attribute and enter name "BO Group" under Custom Value
and save the change.
3. Log out and log in to verify GA is enabled in Participant.
2. Populate the above GA in the Participant table with the BO group using an update statement. This will
require a ticket with support and a script to update the existing Participant records.
3. Change the inbound pre-processing to make sure it populates the correct BO Group for each Participant. If
a Participant has multiple BO groups, then they should be separated by commas and stored in the GA field.
4. Drop a BOTRIG file with the correct file naming convention. Example: NTEL_ BOTRIG _PRD.txt. Express
Data Loader picks the file type from the filename to trigger the sync process, which will automatically
synchronize the BO groups and users based on the BO groups specified in the GA field of the Participant
table. This file can be empty.
This utility allows you to generate a report of the existing BO Groups in the system along with the associated
users in each group. This report is useful to identify the current users in each of the groups.
Drop the trigger file in the inbound folder with the correct file naming convention. Example:
<TENANTID>_BOEXTRACTTRIG_PRD. The content of the file should be empty. Express Data Loader picks
the file type from the filename to trigger the extract process.
Note
This report is useful to validate the current users in each of the BO groups.
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.