This KBA explains the usage and benefits of the <log> segment returned in the Compound Employee API query response.
Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.
SAP SuccessFactors HCM Suite
Errors in the EC admin settings or inconsistent data are handled more graceful and don’t lead to an abort of the API call.
Instead the messages describing the error are appended as child tags to the corresponding <sfobject> segment of the query response.
This <log> tag contains all messages belonging to a particular employee record. The field, that caused the system message remains empty and is not returned by the query response.
The <log> tag contains the following sub-tags:
- <log_item>: there is one <log_item> per field which caused an error. Multiple error messages per field are not supported
- <node_name>: the name of the node (or segment) which contains the erroneous field – only used if errors on field level are addressed
- <field_name>: the hris field name of the erroneous field – only used if errors on field level are addressed
- <xPath>: this XPath can be used by the consumer to located the segment where the erroneous field resides. It can be applied to the query response as a whole. Only used if errors on field level are addressed
- <message_text>: user-friendly error message
- <severity>: indicates whether the message is an information, a warning or an error. Warnings are given, if for example external codes cannot be determined for certain fields. Severity ‘ERROR’ is set if data of an employee cannot be returned at all because of inconsistent data.
- <person_id>: the person ID of the employee – only used if whole segments are inconsistent
- <person_id_external>: the external person id of the employee - only used if whole segments are inconsistent.
Some examples of <log> segment are as follows-
<log> segment in Compound Employee API SF SuccessFactors INT , KBA , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT , Integrations , How To