Module sap.successfactors.ecglobalbenefits

ballerinax/sap.successfactors.ecglobalbenefits Ballerina library

1.1.0

Overview

SAP SuccessFactors Employee Central is a comprehensive human capital management solution that helps organizations manage their workforce effectively. It provides a unified platform for HR processes including employee data management, organizational structures, and employment lifecycle management.

The ballerinax/sap.successfactors.ecglobalbenefits package provides APIs to interact with the SAP SuccessFactors Employee Central Global Benefits API.

Key Features

  • Manage comprehensive employee benefits including insurance and savings plans
  • Access pension funds, company cars, and benefit enrollments
  • Query benefit employee claims and eligibility records
  • Support for basic and OAuth 2.0 authentication

Setup guide

  1. Sign in to your SAP SuccessFactors instance as an administrator.

  2. Navigate to Admin Center > Manage OAuth2 Client Applications and register a new OAuth2 client application for your integration.

    Register OAuth2 App

  3. Note down the API Key (client ID) and configure the appropriate scopes for the Employee Central APIs you intend to use.

  4. Locate your Company ID and the API server hostname for your SuccessFactors region. You can find the list of API servers in the SAP SuccessFactors API documentation.

  5. Use Basic Authentication (username + password) or OAuth 2.0 SAML Bearer to authenticate with the API.

Quickstart

To use the sap.successfactors.ecglobalbenefits connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the sap.successfactors.ecglobalbenefits module.

Copy
import ballerinax/sap.successfactors.ecglobalbenefits as globalbenefits;

Step 2: Instantiate a new connector

Use the hostname and credentials to initiate a client.

Copy
configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

globalbenefits:Client globalbenefitsClient = check new (
    {
      auth: {
        username,
        password
      }
    },
    hostname
);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Copy
globalbenefits:BenefitEmployeeClaimWrapper result = check globalbenefitsClient->listBenefitEmployeeClaims();

Step 4: Run the Ballerina application

Copy
bal run

Examples

The SAP SuccessFactors Employee Central Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like syncing employee data and sending notifications.

  1. Google Sheets to SuccessFactors - Read employee records from a Google Sheets roster and create Personal Information records in SuccessFactors.

  2. SuccessFactors to Slack - Poll SuccessFactors for newly onboarded employees and send welcome notifications to a Slack channel.

Import

import ballerinax/sap.successfactors.ecglobalbenefits;Copy

Other versions

Metadata

Released date: 4 days ago

Version: 1.1.0

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes


Pull count

Total: 2

Current verison: 1


Weekly downloads


Source repository


Keywords

Area/ERP & Business Operations

Business Management/HCM

Cost/Paid

Vendor/SAP

SuccessFactors

Employee Central


Contributors