SAP Knowledge Base Article - Public

2646991 - API Option Profile Settings Manager Transfer - Performance Management

Symptom

  • There is an API Option Profile which can configure manager transfer options and is used for OData API.
  • This article explains how to enable settings in your Success Factors System for Manager Transfer for an OData API call.

Environment

  • SAP Success Factors Performance Management
  • SuccessFactors OData API

Reproducing the Issue

  • You are using OData API to complete a manager transfer.
  • There has been an issue with the Manager transfer and document visibility in the System.

Cause

Several API entities allow specification of “processing parameters” to control extra business logic that can optionally be applied when editing (INSERT, UPDATE, UPSERT) the entity.

User entity with parameter “managerTransfer”

New option profile:

The left side information will be editable.

For profile ID - unique constraint check will be applied, every profile id should be unique, once duplicated profile id is detected, an error message will popup.

For description field - you can specify a short description for this profile for later reference. The maximum length of the description is 200 characters long, description longer than 200 character-lengths will be truncated.

Existing option Profile:

When editing an existing profile, Entity Type and Profile ID will be disabled, you can only change the description of this profile.

Screenshot 2.jpg

All the parameters available for the given entity will be shown for you to edit.

For the user entity, the parameters would be identical to the existing user import function and form template settings.

Once you finished the edit, you can either choose save or discard the change by clicking on the Save or Cancel button.

Resolution

Home > Search "Manage API Option Profile" > "Add"

Screenshot.jpg

How to use API Option profile function

  1. Add/Edit an Option profile with a unique optionProfileID and check features you want to enable.
  2. Send API call with adding specific parameter 'apiOptionProfileID' with configured optionProfileID as value.

An example call:

http://<hostname>/odata/v2/User?apiOptionProfileID=<profile ID

Then selected feature will be run when you insert/upsert User entity.

NOTE: Make sure that all other Generic Permissions of OData are enabled in Provisioning and SuccessFactors Customer Instance.

See Also

SAP SuccessFactors HCM Suite OData API: Developer Guide.

Keywords

API, Manager Transfer, Option Profile, Performance Managerment, Document Visibility. , KBA , csg_q , LOD-SF-PM-API , Webservices, OData APIs , How To

Product

SAP SuccessFactors HXM Suite all versions ; SAP SuccessFactors Performance & Goals all versions