SAP Knowledge Base Article - Public

3010575 - How to extract employee photos to an SFTP folder using Integration Center - SAP SuccessFactors HXM Suite

Symptom

You wish to configure a job to export employee photos from SuccessFactors to an SFTP server.

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

  • SAP SuccessFactors HXM Suite
    • Integration Center


Resolution

Disclaimer: This KBA will focus on the Integration Center extraction method, but it's also possible to configure a job in your instance's Provisioning to extract employee photos to an SFTP: 2715437 - Batch export of profile photos.


Prerequisite

If you do not have access to Integration Center, please check out 2209164 - How to enable integration center in Successfactors System? - Integration.


Creating the integration

  1. Go to Admin Center -> Integration Center -> My Integrations;
  2. Click on 'Create' and select 'More Integration Types';
  3. Select 'Attachment' format and click on 'Create'.


Configuring filters

You may configure filters to limit the integration output to specific groups of employees and a specific photo format (photoType). In the example below, I placed a filter on the user's country to only retrieve photos of users whose country is Brazil (BRA):

As for the photoType value:

  • photoType 1 corresponds to a 130x240 version of the user's profile picture;
  • photoType 20 is the original-sized photo.

There are other photoType values available. To learn more about them and the Photo entity in general, please refer to this page from the OData Reference Guide.

IMPORTANT NOTE: For Attachment export integration types such as this one, there's a limit of 5000 attachments which can be extracted on a single execution, so if your need more than that, it will be necessary to apply filters to reduce the output and split the integration.

Configuring the Destination Settings

Step 1 is just entering your SFTP host address, user credentials and file folder path.

Step 2 allows you to build a custom logic which will define the photo file name of each extracted Photo record. In the example below, I defined the file name calculation as follows:

  • Calculated File name = Photo's User full name + ".jpeg"

Now, all that's left is to run the integration or set a schedule. If you intend to schedule the job to run it regularly, it's recommended to use time-based filters so that it only exports photos which were modified since the last run time. You may refer to Integration Center: Time-based filters. This will dramatically improve performance.

If you're having trouble configuring the integration as you need, please refer to the official Integration Center handbook. If you face any errors or issues during execution, you may open a support case under the LOD-SF-INT-INC component.

Keywords

how-to, extract, export, send, job, ic, picture, image, img, API, configure, configuring, setup, set up, get, retrieve, return, file, files, folder, via , KBA , LOD-SF-INT-INC , Integration Center , LOD-SF-INT , Integrations , How To

Product

SAP SuccessFactors HXM Suite all versions