Symptom
SAP SuccessFactors ODATA API Query operation: Recommended Performance tuning Guidelines
Environment
SAP SuccessFactors ODATA
Resolution
To do the mass data Query operation, we would recommend below:
- Stop execution of scheduled process to avoid failure as mass load will take time and while previous execution is running, you should not submit another request.
- Evaluate how many records are you going to process and if your custom process is capable of processing such data load effectively.
- By default, SuccessFactors Query operation allows 1000 records as a maximum number to be read. However, based on your Query URI complexity, you need to decide lower batch size.
- Proxy timeout during ODATA API call is 7 minutes i.e. your ODATA API request should be processed within 7 minutes by API server and response should be returned back to the client within 10 minutes for a specific batch or else this would cause gateway timeout.
- Each JSESSION ID remains active only for 10 minutes. Hence, you need to make sure session is reused for next batch within this time range to trigger the new batch request. If failed, this would cause "Invaid Session ID" error message.
- You also need to make sure client (CPI/Boomi or any other middleware) has timeout parameter set according to your data load.
- After mass load of data change is completed in SuccessFactors, trigger the process manually.
- Execute the process during non-business hours only to make sure server load is low and there is no timeouts.
Keywords
API Performance, ODATA, Best Practices , KBA , LOD-SF-INT-ODATA , OData API Framework , Problem
Product
SAP SuccessFactors HCM Suite all versions