SAP Knowledge Base Article - Public

3141692 - How to provide API Audit Logs to Cloud Support - SuccessFactors

Symptom

You have reported an API behaviour-related issue and you have been requested to provide API logs by SuccessFactors Cloud Support.

This document will outline the optimal way in which provide these API logs and consequently speed up the handling of your case.

The KBA is applicable to any API call made to SuccessFactors, irregardless of the system the API request is originating from.

This format provides us with a complete picture of the API-specific issue you are facing and allows us to asses the issue from both the front-end and the back-end.

Generally, this format is required when engaging with API engineering or any SF Module API team(s).

"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
    • Compound Employee API
    • OData API
    • SFAPI

Resolution

STEP 1

  • Search for Audit Logs Settings feature, open the relevant tab (OData API or SFAPI) according the API protocol you are using and click on Enable All Payloads.
    IMPORTANT: Choose SFAPI for CompoundEmployee API.



    OBS.: Enable All Payloads will enable all incoming API calls for the next 4 hours. After 4 hours, the option will be disabled automatically and the additional payload logs will stop being recorded. You can check when exactly this will occur by looking at the "Expires at:" as in the screenshot above.

STEP 2

  • Wait 1 minute then reproduce the issue, by running the integration or making the problematic API request;
    IMPORTANT: Reproducing the issue for just for one affected record/employee generate less and more accurate logs;


   

STEP 3

  • Go to OData API Audit Logs feature (or SFAPI Audit Logs) and search for the request in which you reproduced the issue;
    IMPORTANT: Applying filters makes retrieved logs accurate. You can filter by the request time, entity name, API operation, API user and so on. See the example below:


        

STEP 4

  • Click in the '...' button in the last column from the line you wish and download ALL files associated with the request (Request Header, Response Header, Request Payload (POST calls only), Response Payload);
    Attach
    all of these files on the case (preferably consolidated in one .zip folder);


    

TIPS:

  • If the API request comes from CPI & you are using the SF Adapter in CPI,
    "Correlation-Id" in Request Header will match CPI Message ID & you will see the name of the CPI process in "Process-Name"
      
  • If the API request comes from Boomi & you are using SF Adapter, 
    "x-sf-execution-id" should match the execution ID of your Boomi process.

Keywords

KBA , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-CPI , Standard SF to 3rd Party CPI (HCI) Content , LOD-SF-INT-MDF , Metadata Framework API (MDF) , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , LOD-SF-INT-CE , Compound Employee API , How To

Product

SAP SuccessFactors HCM all versions

Attachments

Pasted image.png