Skip to main content
Feedback

SuccessFactors – Partner connector

The SuccessFactors – Partner connector extends the SuccessFactors BizX SFAPI to the Boomi Enterprise Platform and provides a user-friendly interface for creating and managing SFAPI connections and operations.

Attention

According to Boomi's partnership agreement with SAP SuccessFactors, SAP SuccessFactors handles all support for its customers. Whether the issue is purely SuccessFactors or only Boomi, they have experts who can help provide support. Use this link to access their support portal, where you can open a ticket: https://launchpad.support.sap.com.

For provisioning-related requests, contact archana.shanmugam@sap.com or ambika.d01@sap.com. For operations-related matters, contact kavitha.padinjharepura@sap.com, burulai.alimbaeva@sap.com, or manish.singh07@sap.com.

The SFAPI is an entity/object based web services (SOAP) interface that provides typical Create, Read, Update and Delete operations for specified BizX object types and forms. There are three kinds of SFAPI object types:

  • Form-Based Object Types — Objects that reference custom BizX Form objects. These objects have a suffix in the form of <object type>$<form ID>. The Form ID is a unique identifier for the Form object that can vary from Company ID to Company ID.

  • Standard Object Types — Basic objects that do not have the Form ID suffix. The objects names are consistent between Company IDs.

  • ADHsOC Object Type — Objects that extend Ad Hoc Reports to the SFAPI. They support only a Read operation known as Asynchronous Query. There are two types of ADHOC object types:

    • Object types that create new reports when queried. These object types provide access to all the fields of the Ad Hoc Report. These object types are all prefixed with ADHOC_.

    • Object types that represent saved reports created in the SuccessFactors Ad Hoc Report Builder user interface. These object types expose only a subset of the fields defined in the corresponding ADHOC\_ report object type. These object types are named AdhocReport_<reportID>.

note

The following terminology is important:

  • Object Type is synonymous with entity. Boomi uses the term "object" while the SuccessFactors SFAPI materials refer to "entities."

  • Company ID is synonymous with tenant or cloud instance. The Company ID represents a specific instance in a specific data center.

Asynchronous query operations run "asynchronously": the query is executed in the BizX cloud and the cloud is polled periodically using a "get job status" operation, waiting for the report to be queued and completed. When complete, the results are fetched by the SuccessFactors – Partner connector.

Asynchronous queries are very useful because they provide the ability to join multiple related object types. Synchronous queries allow return records only from a single object type. For example, an asynchronous query from an ADHOC object type can return employee data that includes personal information, job history and postal address information related to each employee.

The steps that occur when running an asynchronous query are:

  1. The report is created from a query and saved as an Ad Hoc Report (ADHOC\_ object types only).

  2. A report job is submitted to the scheduler for execution (both ADHOC\_ and AdhocReport\_ saved reports).

  3. The connector periodically executes a "get job status" operation waiting for the report to complete execution.

  4. The report definition is deleted from the Ad Hoc Saved Reports (ADHOC\_ object types only).

  5. The results are downloaded from the SuccessFactors Cloud to the connector.

    note

    Although the Ad Hoc SFAPI returns CSV files in either zipped or non-compressed text formats, the SuccessFactors – Partner connector converts these results to XML, matching the XML profile generated by the connector when an ADHOC object type is imported into the connector.

Report execution results are stored in the SuccessFactors cloud for 30 days. You can log into SuccessFactors and download any report execution from the Saved Reports page. To find the name of the report that is executed, open the Boomi execution log and scroll down to where the report name is logged. Both the report name (prefixed with SFAPI) and the Task/Job ID appears in the Boomi log file.

Connector configuration

To configure a connector to communicate with SuccessFactors, set up three components:

This design provides reusable components, which contain connection settings (such as Endpoint, Company ID, User name, Password) and operation settings (such as Object, Action, data definitions). After building your connection and operation, set up your connector within a process. When you have properly defined the SuccessFactors – Partner connector within your process, Integration can map to and from virtually any system using the connector to retrieve data from or send data to SuccessFactors.

Tracked properties

This connector has no predefined tracked properties. See the topic Adding tracked fields to a connector operation to learn how to add a custom tracked field.

On this Page