SAP Knowledge Base Article - Public

2684271 - Trigger Workflow for Job information / Job history and Termination entities via API

Symptom

You would like to trigger workflows for Job information / Job history and Termination entities using EC imports or OData API

Environment

  • SuccessFactors Employee Central - EC imports
  • SuccessFactors Employee Central - OData API
  • Enable Business Rules for Workflow Derivation

Reproducing the Issue

Workflows are not triggered when create a record via OData API

Resolution


Workflows are enabled for both Imports and OData APIs provided the roles have the appropiate permissions as mentioned in documentations.

The workflows are only supported for Job history and termination entities. The workflows gets triggered for Job history record if:

  1. A record is upserted in incremental mode or in Full purge with SuppressOfIdenticalRecords flag set to true ( example  /odata/v2/upsert?purgeType=full&suppressUpdateOfIdenticalData=true )
  2. A record does not have Hire based event reasons.
  3. A record qualifies for a workflow based on the business rules. There should be at least one business rule that sets a workflow Id on the record and gets satisfied.
  4. A record must have a change with respect to the previous record in the history. If the record is exactly identical as its previous record (meaning no field changes), the workflow does not get triggered even if the record qualifies for a workflow.
  5. A record that qualifies for workflow is not correcting an existing record. Instead an upsert of this record would result in a new time slice creation on the history - Incremental inserts.

Make sure to grant the following permissions to the API user:

  1. Employee Central Import Settings > Enable Workflows for selected entities
  2. Employee Central Import Settings > Enable Business Rules for selected entities
  3. Employee Central Import Settings > Enable execution of rules against NO_OVERWRITE


The behavior should be same from both Imports and APIs.  The termination use cases must be supported for both Imports and APIs.

Please make sure that the respective roles have workflow and Business Rule permissions enabled (refer to 2546341 - Which HRIS elements support workflows on import).

See Also

 Role-Based Permissions for Employee Data Import

Keywords

trigger Workflow for Job information / Job history and Termination entities, EC imports, SuccessFactors Employee Central - OData API, Full purge, SuppressOfIdenticalRecords , KBA , LOD-SF-EC-WFL , Workflows - Configuration, Tools, Objects & Rules , LOD-SF-INT , Integrations , LOD-SF-EC , Employee Central , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , How To

Product

SAP SuccessFactors Employee Central all versions ; SAP SuccessFactors HXM Suite all versions