Activation

How a rule becomes active for a purchase, including always-active, conditionally active, purchaser-invoked, or scoped invocation.

$defs.activation · object

Definition JSON

This fragment is shown exactly as published. Use the chevrons to fold objects and arrays; linked $ref values return to their targets in the complete schema.

{    "type": "object",
    "additionalProperties": false,
    "required": [        "basis"    ],
    "properties": {        "basis": {            "enum": [                "when_document_invoked",
                "when_rule_scope_invoked",
                "when_condition_met",
                "when_document_invoked_and_condition_met",
                "when_scope_invoked_and_condition_met",
                "when_explicitly_invoked_only"            ]        },
        "when": {            "$ref": "#/$defs/condition_expr"        },
        "requisition_input_ids": {            "type": "array",
            "description": "IDs from requisition_interface that must be resolved by the material requisition when this rule is active.",
            "items": {                "type": "string"            },
            "uniqueItems": true        },
        "notes": {            "type": "array",
            "items": {                "type": "string"            }        }    }}

Fields

FieldTypeStatusMeaning
basisenum — "when_document_invoked", "when_rule_scope_invoked", "when_condition_met", "when_document_invoked_and_condition_met", "when_scope_invoked_and_condition_met", "when_explicitly_invoked_only"RequiredHow document invocation, scoped invocation, and stated conditions combine to activate the rule.
whenCondition exprOptionalBoolean condition expression that must be satisfied for the rule to apply.
requisition_input_idsarrayOptionalIDs from requisition_interface that must be resolved by the material requisition when this rule is active.
notesarrayOptionalAdditional explanation of activation behavior.