Skip to main content

Celonis Product Documentation

Download SAP Extractor and on-Prem Agent

This page provides information about the released versions and patches for the SAP ERP Extractor and the RFC module along with release/patch.

  • Celonis_RFC_Data_Extraction_x.y.zip: The transport to be imported into new SAP systems which contain the RFC module (if no RFC module exists in the SAP system).

  • Celonis_RFC_Data_Extraction_x.y-Update.zip: The transport to be imported into the SAP system which contains the RFC module (for SAP system which already have the RFC module installed).

  • Celonis_RFC_Data_Extraction_x.y.ECC5.zip: The transport to be imported into SAP 5.0 which contains the RFC module.

  • Celonis_RFC_Data_Extraction_x.y.ECC4.6C.zip: The transport to be imported into SAP 4.6C which contains the RFC module.

  • yyyy-mm-dd_CELONIS_EXTRACTION.SAP: The user role to be imported into SAP.

  • yyyy-mm-dd_SAP_Extractor_Package.zip: The package containing the extractor and required configuration files, is to be installed on the on-premise server. Included in this package is also the Celonis on-Prem Agent for both Linux and Windows.

Packages

Files for new installations

  • yyyy-mm-dd_SAP_Extractor_Package.zip

  • yyyy-mm-dd_CELONIS_EXTRACTION.SAP

  • yyyymmdd_Celonis_RFC_Data_Extraction.zip

Files for existing installations

  • yyyymmdd_RFC_Celonis_Data_Extraction_Update.zip (to update the given version)

  • yyyy-mm-dd_SAP_Extractor_Package.zip (if it was updated since last installation)

  • yyyy-mm-dd_CELONIS_EXTRACTION.SAP (if it was updated since last installation)

Downloads
Known issues

Component

Affected Version

Issues

RFC Module

> 3.X.X

The check on the custom Authorisation Object ZCELEXTR is not performed before executing the extraction.

RFC Module for SAP ECC and S/4HANA
Joint Agent and Extractor Installer
Extractor Source Files (for manual setup)

Warning

On a Windows server, the latest Extractor version requires Microsoft Visual C++ 2013 Redistributable Package (x64).

It is available for download here: https://support.microsoft.com/en-us/help/3179560/update-for-visual-c-2013-and-visual-c-redistributable-package

RFC Module for Legacy SAP Systems (4.6c and 5.0)
Miscellaneous
Release/Patch Notes SAP Extractor

Version

Notes

2022-07-21, v. 3.10.0

New Features

  • Real time extractions from the views

2022-02-10, v3.

Fix

  • Changelog timestamps in target table were missing milliseconds

  • Changelog timestamps in target table were not calculated correctly

Update

  • Optimized queries to check the trigger status and metadata

2021-11-16, v 3.7

New Features

  • Offset for the dependency of CDHDR/CDPOS according to the system timezone

  • Support for Change Log timestamps in microseconds (was added with RFC Module version 3.1.0

2021-08-04, v 3.5

Update

  • Updated Celonis on-Prem Agent v1.0.1

    • Added retry mechanism when the connection/read times out

    • Added retry mechanism when the Agent registration fails due to an Agent instance status conflict

    • SAP-related updates:

      • Added support for older SAP versions to generate metadata

      • Added support for changing parameters

      • Fixed error messages

2021-07-16, v 3.5

New Features

  • Included the clean up Background Jobs in the connection limit count

  • Log when the limit of parallel extractions is exceeded

Fix

  • A failed table cancels all other tables in a Task

  • Upgrade of the RFC Module forced to perform a restart of the Extractor. Fixed by invalidating JCO's ABAP metadata repo on RFC Module version change, to avoid syntax errors

2021-06-01, v 3.3.4

New Features

  • Improved logic of the direct deletes in the Replication Cockpit

  • Added the Extractor version to the Version Information

Fix

  • When the extraction for inserts/updates failed, and the one for deleted records was successful, all records have been marked as successfully extracted.

2021-04-29,

v 3.3.0

New Feature

  • Published a Windows Installer that automates the Extractor setup. The setup details can be found here.

Fix

  • The check for missing VC++ 2013 was not captured in the connection test

2021-04-22,

v 3.2.0

Fix

  • The parameter to execute the CL table update and clean up via chunks was not passed to SAP.

2021-03-03

New Features

  • Clean up jobs for the Change Log tables are by default run as SAP Background Jobs (the feature requires RFC version 2.2.2)

2021-02-18

Fix

  • Fixed the handling of missing authorisation rights in the connection test checklist

2021-02-15,

v 3.1.0

Release Notes

New Features

  • A checklist during the connection test to pinpoint to the connection problem

2021-02-11

Fixes

  • A dependency has been excluded from the extractor

2021-02-04,

v. 3.0.0.

Release Notes

New Features

  • Option to turn the chunking mode of the clean up job on/off, and define the chunk size

  • Define how the deleted records are handled

  • Define how the records generated from other Clients are handled during the extraction

  • The SAP Java Connector (SAP JCo) setup is done separately

Fixes

  • The Extracted Date was not updated in the CLMAN

  • Logging was broken for the Spring version

2021-01-19

Update

  • Updated Celonis on-Prem Agent

2020-11-16

Update

  • Updated Celonis on-Prem Agent

2020-11-06

New Features

  • Display the Change Log table and Trigger statuses in the Replication Cockpit

  • An option to turn on detailed logging for Replications

  • Daily calculation and publication of CL table sizes

2020-10-28

Fixes

  • Fixed an issue related to missing authorisation rights

2020-10-19

New Features

  • An option to ignore metadata changes of a table

  • Upgrade to the library JCo 3.1

  • Enable/Disable the Real Time (Change Log) extraction logs for the desired table in EMS => Data Integration

  • Multi-target data push jobs

  • Show the Change Log and Trigger status for the table in EMS Data Jobs

Fixes

  • The merge condition for Delta Loads was incorrect when the Primary Key was overridden, causing unnecessary deletion of records

  • Duplicate records when there was a join on a table with 1-n relationship, i.e. VBAK on VBAP

  • Backward compatibility with older versions of on-premise Data Integration

2020-09-04

Fix

  • Fixed a bug with custom join conditions for specific tables

2020-08-13

Fix

  • Fixed memory issue when retrieving table metadata

2020-07-27

Fixes

  • Retry attempt failed in case the data load to EMS database took longer than 2 hours.

2020-07-15

New Features

  • Support for SUBSTR_ANON function that substrings the column in SAP and pseudonymizes it before sending to the Extractor

Fixes

  • Exclude the unrecognized characters that cannot be stored in the EMS application database from logs published to EMS

2020-07-09

Fix

  • Fixed the regression affecting the column value filter functionality

2020-06-30

Fix

  • Added handling of more exceptions for retrying to list the Z_CELONIS_TARGET directory.

2020-06-22

Fix

  • Reverted the feature of automatic clean-up of leftover files from temp directories on SAP and Extractor servers (implemented in 2020-02-07). In some environments, the file creation timestamp was not populated properly by the file system, and the files were being removed before being extracted.

2020-06-17

New Features

  • Real-time extractor checks for new records before triggering an SAP extraction job

  • Configurable pseudonymisiation algorithm (SHA1, SHA2, SHA512)

Fix

  • Canceling extraction jobs in EMS did not cancel all active background jobs in SAP

2020-05-13

Fix

  • Fixed backward compatibility issue with older RFC modules

2020-04-28

New Features

  • Extraction Parameters can now be defined in the Connection Details=>Advanced Setting

  • Detailed information about the SAP System and Extractor Server is logged in EMS (requires RFC module version 1.8 and higher)

  • Download of the local extractor logs from EMS

Fix

  • Reverted setting the SAP connection language to EN, because it is not properly supported for some older SAP versions. The Celonis SAP user's language setting will be used.

2020-03-23

  • Added scripts for installing Windows service using SNC

2020-03-06

New Features

  • The SAP Job logs are always written to the EMS execution log

Fixes

  • Extractor keeps re-trying in case the export directory in SAP (Z_CELONIS_TARGET) is not reachable temporarily

2020-02-28

New Features

  • Custom prefix can be defined for the SAP Background Job in the application-local.yml (requires RFC Module 1.71 and higher)

Fixes

  • Extractions failed for connections via proxy

2020-02-21

New Features

  • The chunk size (by default 50,000 rows) can be modified in the application-local.yml

  • The SAP Job logs are always retrieved to extractor logs when in debug mode

Fixes

  • Failed to fetch logs of failed SAP jobs. The bug has been introduced in version 2020-02-07.

2020-02-07

New Features

  • Parallel execution of push jobs to EMS

  • Automatic clean up of leftover files from temp directories on SAP and Extractor servers (Requires RFC Module 1.7 and later)

  • Synchronising deleted records between EMS and SAP (requires Change Log extraction mode)

Fixes

  • Fix missing extractor version in Data Connection

2019-12-03

New Features

  • SAP session language is set to English when available

Fixes

  • Fix for slow uplink connection between Extractor and EMS when via proxy server

  • Recreate the winutils.exe file during the extraction in case of accidental deletion

  • Trim trailing white spaces of non-string types

  • Improve deletion of left over uncompressed files when SAPCAR is being used

  • Increase number of retries when encountering Extractor -> SAP RFC connection timeouts

2019-11-14

Fixes

  • Fix formatting of double parameter values used in filters

  • Log a warning when encountering a CSV line corrupted during transfer to the filesystem in SAP and continue the extraction

2019-11-12

New Features

  • Support for Native SAP compression method

Fixes

  • Remove trimming of leading white spaces

  • Fix "destination changed" errors with multiple logon group connections

2019-10-29

New features

  • Add support for connections via PI/PO

  • Include the RFC Module version in the status of Uplink Integrations

2019-10-15

Fixes/Improvements

  • Allow increasing and lowering 'Maximum Parallel Table Extractions' without requiring an extractor restart

  • When debug logging is enabled and a malformed chunk is provided by SAP, log a sample of 10 lines from the chunk to aid troubleshooting

2019-09-27

New features

  • Proxies with authentication

  • Add 'celonis.sap.run_anywhere' local configuration option so batch jobs are dispatched dynamically (requires latest RFC Module)

Fixes/Improvements

  • Fix displaying the SAP job log multiple times

  • SAPCAR decompression fixes

2019-09-11

Warning

Requires Java 11 (OpenJDK 11 is also supported, we recommend AdoptOpenJDK 11, seehttps://adoptopenjdk.net/index.html?variant=openjdk11)

New features

  • Support for SAPCAR as a compression method

Fixes/Improvements

  • Improved file management so that the peak disk space requirements are reduced

  • Improved parallel extraction of multiple tables

  • Improved connection test resilience

  • Fixed an issue where not all chunks were correctly processed

  • Fixed an issue where extraction cancellations did not work

2019-08-02

  • Fixed an issue where temporary files were not deleted

2019-07-05

  • New more robust extraction method: polling the SAP systems for new files, also removed the need for a connection from the SAP to the extractor

  • Robustness improvements of the upload mechanism

  • Improved logging

  • Added resources to the package for using SNC, see Configuring SNC with the SAP Extractor

Compatibility

This extractor version requires the RFC module version 2019-04-17 or later

2019-05-24

New features

  • LIKE/NOT LIKE are now allowed in filters

  • Bulk import of tables in extractions

Fixes/Improvements

  • Fixed an issue in the connection test when the compression did not work

2019-04-11

Fixes/Improvements

  • Robustness improvements

  • Fixed an issue where the upper bound of a filter was shifted

2019-02-14

New feature

  • Support for SAP Logon groups

Fixes/Improvements

  • Robustness improvements

2018-12-19

Fixes/Improvements

  • Improved robustness in case of system unavailabilities

2018-12-10

Fixes/Improvements

  • Improved robustness of the data extraction

New feature

  • Added option to use SNC (SSL connection between Extractor and SAP)

2018-10-25

Fixes/Improvements

  • Improved method of retrieving files that could not be sent due to network issues

  • The connection test now checks more reliably that files are actually received from SAP

New feature

  • Added template to run the Extractor as a Windows service

Remark: From this version on, the default configuration file that is used is named application-local.yml

2018-09-04

Fixes/Improvements

  • Fixed problem with umlauts and other special characters

  • Added support for HTTPS between SAP and the Extractor

  • Added configuration default values for HTTPS in application.yml

2018-08-07

Proxy support

  • Added proxy support for proxy servers between the Extractor and the cloud (currently only unauthenticated proxy servers are supported)

  • Added proxy configuration file in the package

Remark: If no proxy is used, you can also remove the proxy configurations from the application-default.yml and remove the proxy.yml file.

Release/Patch Notes RFC Module

Version

Notes

3.1.3

New Feature

  • Feature to test the trigger creation in the CLMAN_UI

Fixes

  • Trigger creation failed for the SAP systems running on HANA database.

  • Trigger creation failed for tables with columns of .INCLUDE type.

  • Change Log table creation failed when one of the Primary Key columns included "/" in the name.

  • The "last extracted date" was not updated in the CLMAN_UI.

  • Extraction failed when the file clean up failed once.

3.1.2

Fixes

  • Incompatible Data Type for non-ECC systems.

  • Incompatible trigger creation for specific DB2 version.

  • Several incompatibilities with older SAP_BASIS versions.

  • Fixed pop-up dialogues in /CELONIS/CLMAN_UI.

3.1.1

Fixes

  • Compatibility fixes for older Netweaver versions

  • Wrong data type for the Change timestamp for DB2 database

  • In some scenarios record count in the Change Log table was wrong

3.1.0

New Features

  • The Change Log tables can by created by process with one click in the /CELONIS/CLMAN_UI

  • 'Check Table' function in /CELONIS/CLMAN_UI to pre-validate the change log tables before creating them

  • The Changelog timestamp is now captured in microseconds (Note: This requires the re-creation of the changelog tables and triggers)

  • Offset for the dependency of CDHDR/CDPOS according to the system timezone

Fix / Improvement

  • Additional checks and validations if the Change Log table exists in the Database

  • Failed to extract tables that had "/" in their name

  • The SAP Job Log did not include the column names of the join condition

Compatibility

Changelog Tables that were created with this version require at least the Extractor v 3.7.0. Older versions are not compatible.

Note

From this version on, the FULL transport does not contain any pre-packaged Changelog tables anymore. Instead, they can be created per process in the /CELONIS/CLMAN_UI

3.0.1

Fixes

  • Fixed a SQL syntax bug affecting SAP systems running on DB6

3.0.0

Technical refactoring with no features or fixes

Note

For technical reasons. only the FULL transport has been published for v 3.0.0. For the UPGRADE transport v 2.4.3 is still active. Two transports don't have functional differences, so it is OK to go ahead with 2.4.3 for the upgrade.

An UPGRADE transport for v3 will be published in the next weeks.

2.4.7

Fixes

  • The trigger creation failed for specific DB2 versions

  • Compatibility adjustments for older netweaver version

2.4.3

Fixes

  • The Trigger creation failed for an older Sybase DB

  • Deprecate the Commands Z_CELO_GZIP and Z_CELO_SAPCAR from the Full Transports

  • CL-Tables could not be created when original Table had buffer type "Generic Buffer"

  • Fixed a bug in the CL table size calculation function

2.4.2

Fixes

  • Fixed a backward version compatibility issue

2.4.0

New Features

  • Real Time Extraction Support for Sybase

  • Showing the eligibility of a table for Real Time extraction in the T Code CELONIS/CLMAN_UI

2.3.0

Fixes

  • Chunking parameter did not affect the behavior of clean up Background Jobs in SAP

  • For older SAP versions the umlaut characters were extracted as question marks

  • The Change Log table creation failed silently when the table was activated in DDIC, but actually not created in the db.

  • The table category and table size category were not set when creating a CL table in SAP.

New Features

  • The CL tables is created with indexes on the Primary Keys

2.2.3

Fixes

  • Replaced some data types and syntax which was supported only in Netweaver versions 7.5 and higher.

2.2.2

New Features

  • Clean up jobs for the Change Log tables are by default run as SAP Background Jobs (requires Extractor version 2021-03-03)

2.2.1

Fixes

  • Fixed an issue preventing real-time extractions from tables with proxy objects

  • Extended the character length of the join statements to 65k

  • Added the package /CELONIS/RFC to the transports

2.1.0

New Features

  • Added the Log Tables of the most common tables from O2C, P2P, AR and AP to the Full Transport

Fixes

  • Removed the Z_CELO_DISKSPACE command

2.0.4

Fixes

  • Fixed an issue related to the calculation of the Change Log table sizes

  • Add an object to remove the program /CELONIS/UPLOAD if it already exists

2.0.3

New features

  • Added authorisation checks on programs /CELONIS/CLEANUP, /CELONIS/CLEAN_UP

  • Removed the deprecated program /CELONIS/UPLOAD

2.0.2

Fixes

  • Fixed a compatibility issue that blocked the import of the module

2.0.1

Fixes

  • The real-time extraction returned no records when the "include change type/timestamp" option was not selected in the connection form

2.0.0

New features

  • Real-Time Extractor fetches records via a dialogue work process in case there is only 1 chunk (50k records)

  • Real-Time Extractor updates and cleans up the Change Log records in chunks to avoid deadlocks

  • Real-Time Extractor cleans up the Change Log records immediately after the extraction

  • Support for multi-client scenarios. The Real-Time Extractor will fetch only the records originating from the client that is defined on the Data Connection

1.8.8

Fixes

  • Bug related to buffer retry in 1.8.4

  • compatibility fix in /CELONIS/CLEAN_UP

1.8.7

Fix

  • Pseudonymisation function failed for older SAP version (NW 7.00)

1.8.6

Fix

  • Fixed the regression affecting the column value filter functionality. Due to a function change the recommended value is 4K now, instead of 10K as before.

1.8.4

New Features

  • Support for SUBSTR_ANON function that substrings the column in SAP and pseudonymises it before sending to the Extractor

Fixes

  • The real-time extractor did not return the delta for tables with composite primary keys, when the additional CL columns (timestamp, change type) where included in the extraction

1.8.3

New Features

  • Real-time extractor checks for new records before triggering an SAP extraction job

  • Configurable pseudonymisiation algorithm (for setup details check here).

1.8.1

Fixes

  • The command to check SAP system info failed for S4/HANA

1.8

New Features

  • Real-time extractor is included in the RFC Module transports

  • Real-time extractor supports HANA database

  • Success/Failure Messages in Change Log configuration screen when creating tables/triggers

Fixes

  • Sorting was not working properly in Change Log configuration screen, in SAP GUI (t code /CELONIS/CLMAN_UI)

1.7.3

Fixes

  • Clean up SAP Job Logs from unrecognised characters

1.7.2

2020-03-02

Fixes

  • When using the 'buffer-retry' option, the comparison between memory buffer and file contents could incorrectly fail

1.7.1

2020-02-27

New Features

  • Support for SAP Background Jobs with custom prefix (requires Extractor version 2020-02-27 or later)

1.7

2020-02-20

New Features

  • Automatic clean up of leftover files from temp directories on SAP and Extractor servers (requires Extractor version 2020-02-07 or later)

1.6

2019-11-12

New Features

  • Support for native SAP compression method

Fixes

  • Retry when compression command fails

  • Logging filenames in uncompressed mode

1.5.2

2019-09-18

Fixed an incompatibility with older SAP versions (before 7.4)

1.5.1

2019-09-10

Fixed an issue with the build

1.5

2019-08-28

  • It is now allowed to use fields in joins that do not have the same length

  • Background jobs are now always dispatched to the system with the RFC module in case of a distributed architecture

  • Support for SAPCAR compression

2019-07-02

  • Fixed an issue with a false negative connection test

2019-06-14

  • Improved status handling

  • Fixed an issue with naming of chunks

  • Robustness improvement for the polling extractions

Compatibility

This RFC module version (and future versions) are not compatible with extractors 2019-05-24 and earllier

2019-04-17

  • Improved error handling

  • Support for requesting table information in batch

  • Released jobs which have not started yet can be cancelled

  • Fixed problem with short dumps if a file is missing during replay

  • Inclusion of some general function calls to the RFC module

2018-11-23

  • Allows polling the SAP system instead of it pushing files to the extractor

2018-10-15

  • Improved error messages in case of errors in the SAP logs

  • Reduced default package size to improve memory consumption in the SAP system

2018-10-10

  • Fixes a problem where chunks can be inserted multiple times by including the filename in the call

  • External command for compression is now OS independent

2018-09-14

  • Support for SAP 6 EHP 4

  • Improved error messages

  • External commands are more generic to cover more operating systems like AIX

2018-07-18

  • Fixed an issue with join filters that caused the extraction to fail

  • Fixed an issue where chunks could become larger than the specified limit

Release/Patch Notes Change Log Extractor (merged with RFC Module transports)

Version

Notes

1.1

New features

  • Automated clean up of log tables via a background job

  • Support for MS SQL database

  • Batch actions in CL Management UI

Release/Patch Notes SAP User Role

Date

Notes

2020-09-16

Added /CELONIS/46C_EXTRACTION to the object S_RFC to support the RFC Module for SAP 4.6c

2020-09-11

Add rights for executing command Z_CELO_DISKSPACE and function group SYSU

2020-01-03

Added rights for Change Log extraction

2019-01-23

Fixed an issue with missing permissions

Release/Patch Celonis on-Prem Agent

Date

Notes

2020-06-30

New Features

  • Added Celonis on-Prem Agent to SAP_Extractor_Package.zip