Create or Update Entity Record
Creates a record of a Data Hub entity, or updates the one whose unique key field has the same value.
Behaviour
Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash
Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.dataHub.upsertRecord
Properties#
Input#
Entity#
Entity · String · Required · Default: Not specified in package metadata
The entity's name in the job's workspace, such as Invoice.
Key Field#
KeyField · String · Required · Default: Not specified in package metadata
A unique field whose value finds the record to update, such as invoiceNumber. Its value must be in Values.
Values#
Values · IDictionary<String, Object> · Optional · Default: Not specified in package metadata
The field values by field name, the key field's included. A decimal, date or datetime value is sent in its field's form.
Values JSON#
ValuesJson · String · Optional · Default: Not specified in package metadata
The field values as a JSON object, such as {"invoiceNumber":"INV-23","amount":"1204.5"}. Use instead of Values.
Output#
Record#
Record · Dictionary<String, Object> · Output
The record as stored: id, revision, createdAt, createdBy, updatedAt, updatedBy and every field.
Record Id#
RecordId · String · Output
The record's id.
Revision#
Revision · Int32 · Output
The record's revision after the change.
Created#
Created · Boolean · Output
True when no record had the key and one was created.
Rules#
- Set only one of: Values, Values JSON.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.
Every activity also has the engine's common properties: Timeout and Continue On Error.
Related activities#
- Create Entity Record
- Delete Entity Record
- Get Entity Record
- Query Entity Records
- Update Entity Record
Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Data Hub. Keywords: data hub, data service, entity, record, upsert, create, update, merge, key, orchestrator.
Properties
Input
Output
Rules
Retry and risk
Related activities