This page describes how to extract data from any entity within theSAP SuccessFactors Employee Central module intoGoogle Cloud with Cloud Data Fusion.

For more information, see theoverview of SAP on Google Cloud.

Before you begin

Set up the following systems and services that are used by the SAPSuccessFactors plugin:

1. Configure the SAP SuccessFactors system. You mustset up permissions in your SAP system.
2. Deploy the SAP SuccessFactors plugin inCloud Data Fusion. You must deploy a plugin version that'scompatible with the Cloud Data Fusion version.
   • If you upgrade the version of your Cloud Data Fusioninstance or plugin, evaluate the impact of the changes to thepipeline's functional scope and performance.
3. Establish connectivity between Cloud Data Fusion and SAPSuccessFactors.
   • Ensure that communication is enabled between theCloud Data Fusion instance and the SAP SuccessFactors instance.
   • For private instances, set upVPC network peering.

Configure the plugin

1. Go to the Cloud Data Fusion web interfaceand clickStudio.
2. Check thatData Pipeline - Batch is selected (notRealtime).
3. In theSource menu, clickSuccessFactors. The SAP SuccessFactorsnode appears in your pipeline.
4. To configure the source, go to the SAP SuccessFactors node and clickProperties.

5. Enter the following properties. For a complete list, seeProperties.

   1. Enter aLabel for the SAP SuccessFactorsnode—forexample,SAP SuccessFactors tables.

   2. Enter the connection details. You can set up a new, one-time connection,or an existing, reusable connection.

      One-time connection

      To add a one-time connection to SAP, follow thesesteps:

      1. KeepUse connection turned off.

      2. In theConnection section, enter the following informationfrom the SAP account in these fields:

         1. Provide the SAP credentials.
         2. In theSAP SuccessFactors Base URL field, enter your SAPSuccessFactors account base URL.
         3. In theReference name field, enter a name for theconnection that identifies this source for lineage.
         4. In theEntity Name field, enter the name of the entityyou're extracting—for example,people.
         5. To generate a schema based on the metadata from SAP that mapsSAP data types to corresponding Cloud Data Fusion datatypes, clickGet schema. For more information, seeData type mappings.
         6. In theProxy URL field, enter the Proxy URL, including theprotocol, address, and port.

         7. Optional: to optimize the ingestion load from SAP, enter thefollowing information:

            1. To extract records based on selection conditions, clickFilter options andSelect fields.
            2. In theExpand fields, enter a list of navigation fieldsto be expanded in the extracted output data. For example,customManager.
            3. InAdditional query parameters, enter parameters to addto the URL—for example,fromDate=2023-01-01&toDate=2023-01-31.
            4. In theAssociated entity name field, enter the name of theentity to be extracted—for example,EmpCompensationCalculated.
            5. In thePagination type field, enter a type—for example,Server-side pagination.

      Reusable connection

      To reuse an existing connection, follow these steps:

      1. Turn onUse connection.
      2. ClickBrowse connections.

      3. Click the connection name.

         Note: For more information about adding, importing, and editingthe connections that appear when you browse connections, seeManage connections.

      If a connection doesn't exist, create a reusable connection byfollowing these steps:

      1. ClickAdd connection> SAP SuccessFactors.
      2. On theCreate a SAP SuccessFactors connection page that opens,enter a connection name and description.
      3. Provide the SAP credentials. You can ask the SAP administratorfor the SAP logon username and password values.
      4. In theProxy URL field, enter the Proxy URL, including theprotocol, address, and port.
      5. ClickCreate.

Properties

Supported filter options

The following operators are supported:

Use cases

The following example use case is the data for a single employee inEmployeePayrollRunResults:

The example shows the results for an employee inEmployeePayrollRunResults:

{"artifact":{"name":"data-pipeline-1","version":"DATA_FUSION_VERSION","scope":"SYSTEM"},"description":"","name":"Demo_SuccessFactors_BatchSource","config":{"resources":{"memoryMB":2048,"virtualCores":1},"driverResources":{"memoryMB":2048,"virtualCores":1},"connections":[{"from":"SAP SuccessFactors","to":"BigQuery"}],"comments":[],"postActions":[],"properties":{},"processTimingEnabled":true,"stageLoggingEnabled":false,"stages":[{"name":"SAP SuccessFactors","plugin":{"name":"SuccessFactors","type":"batchsource","label":"SAP SuccessFactors","artifact":{"name":"successfactors-plugins","version":"PLUGIN_VERSION","scope":"USER"},"properties":{"useConnection":"false","username":"${username}","password":"${password}","baseURL":"${baseUrl}","referenceName":"test","entityName":"${EmpCompensation}","proxyUrl":"${ProxyUrl}","paginationType":"serverSide","initialRetryDuration":"2","maxRetryDuration":"300","maxRetryCount":"3","retryMultiplier":"2","proxyUsername":"${Proxyusername}","proxyPassword":"${Proxypassword}"}},"outputSchema":[{"name":"etlSchemaBody","schema":""}],"id":"SAP-SuccessFactors"},{"name":"BigQuery","plugin":{"name":"BigQueryTable","type":"batchsink","label":"BigQuery","artifact":{"name":"google-cloud","version":"BIGQUERY_PLUGIN_VERSION","scope":"SYSTEM"},"properties":{"useConnection":"false","project":"auto-detect","serviceAccountType":"filePath","serviceFilePath":"auto-detect","referenceName":"Reff","dataset":"SF_Aug","table":"testdata_proxy","operation":"insert","truncateTable":"true","allowSchemaRelaxation":"true","location":"US","createPartitionedTable":"false","partitioningType":"TIME","partitionFilterRequired":"false"}},"outputSchema":[{"name":"etlSchemaBody","schema":""}],"inputSchema":[{"name":"SAP SuccessFactors","schema":""}],"id":"BigQuery"}],"schedule":"0 1 */1 * *","engine":"spark","numOfRecordsPreview":100,"rangeRecordsPreview":{"min":1,"max":"5000"},"description":"Data Pipeline Application","maxConcurrentRuns":1,"pushdownEnabled":false,"transformationPushdown":{}}}

What's next

• Learn more aboutSAP on Google Cloud.