CpqVariableType

A single value the shopper sets, such as a measurement or a free-text engraving

type CpqVariableType {
  id: String
  name: String
  description: String
  valueType: CpqVariableValueType!
  value: CpqValue
  defaultValue: CpqValue
  required: Boolean!
  available: Boolean!
  readOnly: Boolean!
  min: Decimal
  max: Decimal
  step: Decimal
  decimals: Int
  unit: String
  selectionSource: CpqSelectionSource!
  valueSource: CpqValueSource!
  sortIndex: Int
  messages: [CpqMessageType]
}

Fields

id ● String scalar

The variable id

name ● String scalar

The variable name, in the requested language

description ● String scalar

The variable description, in the requested language

valueType ● CpqVariableValueType! non-null enum required

The type value and defaultValue carry

value ● CpqValue scalar

The value the variable currently holds

defaultValue ● CpqValue scalar

The value the variable takes when nothing sets it

required ● Boolean! non-null scalar required

'true' when the configuration is not valid until this variable holds a value

available ● Boolean! non-null scalar required

'false' when the shopper's other choices rule this variable out

readOnly ● Boolean! non-null scalar required

'true' when the ERP sets the value itself, from a formula or another element it follows, and a change to it is refused. A read-only variable that is required and has no value is waiting on the inputs it is computed from, not on the shopper.

min ● Decimal scalar

The lowest value a numeric variable takes

max ● Decimal scalar

The highest value a numeric variable takes

step ● Decimal scalar

The increment the value has to land on between the minimum and the maximum

decimals ● Int scalar

How many decimals a numeric value carries

unit ● String scalar

The unit the value is measured in, such as 'mm'

selectionSource ● CpqSelectionSource! non-null enum required

Why the variable is available the way it is

valueSource ● CpqValueSource! non-null enum required

Where the current value came from. Whether it can be changed is 'readOnly'.

sortIndex ● Int scalar

Orders this variable against every other member of the same section, its sibling variables, the option groups and the nested sections alike. Sort those on sortIndex, nulls last, and render them in that order. Null on every member means no order was reported, so keep the order the lists arrive in.

messages ● [CpqMessageType] list object

Messages about this variable

Member Of

CpqSectionType object