Skip to content

entity-cross-plugin-action-config schema

One config row for the generic engine-entity.cross-plugin-action job — a trigger_entity row entering a triggering status fans out create/update onto every related_entity row keyed back to it (offboarding fan-out; trigger may be another plugin's entity).

Pull the full JSON Schema: erp schema pull entity-cross-plugin-action-config  ·  MCP: erp_get_schema {"name":"entity-cross-plugin-action-config"}

Top-level properties

PropertyTypeRequiredNotes
action_codestringyesStable identifier / natural key for idempotent seeding.
trigger_entitystringyesEntity A - the record whose status change triggers the fan-out (often owned by another plugin, e.g. employee).
trigger_status_fieldstring
trigger_status_instringComma-separated statuses that make a trigger row eligible (e.g. TERMINATED,SEPARATED). Blank = every row.
trigger_date_fieldstringOptional date gate column on the trigger row (e.g. separation_date).
trigger_date_compare_opstringone of: lte, lt, gte, gt
trigger_day_offsetintegerCompare trigger_date_field against now + this many days.
trigger_key_fieldstringField on the trigger row whose value matches related rows (usually id -> employee id).
related_entitystringyesEntity B - the rows acted on.
related_match_fieldstringyesFK column on related_entity that equals the trigger row's key (e.g. employee_id).
related_status_fieldstring
related_status_instringComma-separated statuses a related row must be in to be acted on (e.g. ALLOCATED,ACKNOWLEDGED,IN_USE).
create_entitystringCreate-outcome: entity a row is created in per matched related row (e.g. hcm_asset_return). Omit to only update the related row.
create_dedupe_fieldstringNumeric (long) column on create_entity holding the related row's id - dedupes re-runs. MUST be numeric, not text (EntityRecordService binds numeric-looking filter values as bigint).
create_template_jsonobjectStatic fields set on every created row. String values may contain ${date} ${ts} ${uuid} ${relatedId} ${triggerKey} - substituted per created row so a required-unique column (e.g. return_number) never collides.
create_field_map_jsonobject{targetField: relatedField} - copies related row values into the created row.
related_set_fieldstringUpdate-outcome: column on the related row to write (e.g. status). Idempotent - skipped when already equal to related_set_value.
related_set_valuestringValue written into related_set_field (e.g. RETURN_PENDING).
seeded_bystring
activebooleanyes