VariableDeclarationInput
A variable the instructions and the greeting may refer to (1.17.0).
An object with 7 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
default | VariableValue | no | The value used when a Call supplies none. It matches the type (variable_type otherwise) and is refused on a required variable. An optional variable without a value or a default renders empty. |
description | string | no | What the variable carries, for the people who start Calls. |
max_length | integer | no | For a string only: the longest value a Call may supply; a Call start with a longer one is refused with variable_type. |
name | VariableName | yes | |
phi | boolean | no | The value may be PHI (from 1.32.0, workspace ADR 0082, decision 3). A phi variable takes no default: publish refuses one with the issue variable_phi_default. Its value is read once, by the claim, whose Audit event call.claim names the phi variables rendered and never a value, as from 1.34.0 does the Call event phi.read; the Session configuration then carries phi_values, and the worker refuses model I/O capture (the Call event capture.refused, from 1.34.0); and the api removes the value from the Call when the Call ends. False when omitted. |
required | boolean | no | A Call start without a value is refused with variable_missing. False when omitted. |
type | VariableType | yes |