Member Junction
    Preparing search index...

    Interface TaskCompensationStepMetadata

    Compensation settings persisted in Task.Configuration.compensation: on a forward step, how to undo it; on a compensation task, the policy for its own failure.

    interface TaskCompensationStepMetadata {
        compensationActionId?: string;
        compensationActionName?: string;
        inputMapping?: string | Readonly<Record<string, string>>;
        isIdempotent?: boolean;
        onCompensationFailure?: ActionCompensationFailurePolicy;
        retryCount?: number;
    }
    Index

    Properties

    compensationActionId?: string

    The MJ: Actions ID of the compensation action.

    compensationActionName?: string

    The compensation action's name, resolved to compensationActionId at submit or dispatch time.

    inputMapping?: string | Readonly<Record<string, string>>

    Compensation parameter name → path into the forward run (input.*, output.*, actionLogId, recordChanges).

    isIdempotent?: boolean

    On a forward step: false stops its action being retried automatically. It can only narrow Action.IsIdempotent, never widen it: true on a non-idempotent action changes nothing.

    onCompensationFailure?: ActionCompensationFailurePolicy

    What to do when the compensation itself fails after its retries. Default 'EscalateToHumanTask'.

    retryCount?: number

    How many times the compensation task retries, when its action is idempotent.