variables.json Attributes

Named nodes, each representing a single variable. Each node contains the following attributes:

variable Attributes 

AttributeRequiredDescription
computedValueNoThe computed value for the variable. The computed value is set by the WaveTemplateConfigurationModifier implementation.
descriptionNoAdditional text that appears under the label for more information.
defaultValueNoThe default value for the variable, if the user doesn’t change the value in the wizard. Can be the most likely value a user would use.
excludeSelectedNoIndicates whether values selected for another variable are excluded from the list of values for this variable () or not (). For use with variable types like SObjectType or SObjectFieldType. The default is false.
excludesNoAllows specific values to be excluded from the picker selections
labelNoThe visible label for the variable in the UI wizard. The format is typically a question like “Do you use product?”.
requiredNoIndicates whether the variable value required in the UI. The default is false.
variableTypeNoThe variable type.

variableType Attributes 

AttributeRequiredDescription
dataTypeNoSpecifies the data type for a FieldType variable types. The data type value format for SObjectFieldType is xsd:string. See Primitive Data Types in the Salesforce Object Reference for more values. For DataLakeObjectFieldType and DataModelObjectFieldType, valid values are string, number, date, and date_time.
fieldTypeNoSpecifies the field type for a CalculatedInsightsFieldType variable. Valid values are dimension and measure.
enumsNoSpecifies a list of values for an enumerated variable type for a StringType or NumberType variable type.
enumsLabelsNoSpecifies a list of labels for the enumerated values of a StringType or NumberType variable only.
itemsTypeNoSpecifies the items type for an ArrayType variable. The items type must be a valid variable type.
maxNoSpecifies the maximum value for a NumberType variable only.
minNoSpecifies the minimum value for a NumberType variable only.
typeYesThe type of the variable. Valid types are:
  • ArrayType (Enumerated)
  • BooleanType (Enumerated)
  • CalculatedInsightFieldType (Object)
  • CalculatedInsightType (Object)
  • ConnectorType (String)
  • DataLakeFieldObjectType (Object)
  • DataLakeObjectType (Object)
  • DataModelFieldObjectType (Object)
  • DataModelObjectType (Object)
  • DatasetAnyFieldType (Object)
  • DatasetDateType (Object)
  • DatasetDimensionType (Object)
  • DatasetMeasureType (Object)
  • DatasetType (Object)
  • DateTimeType
  • NumberType (Enumerated)
  • SObjectFieldType (Object)
  • SObjectType (Object)
  • StringType (Enumerated)

See Also