variables.json Attributes

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

variable Attributes

Attribute Required Description
computedValue No The computed value for the variable. The computed value is set by the WaveTemplateConfigurationModifier implementation.
description No Additional text that appears under the label for more information.
defaultValue No The 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.
excludeSelected No Indicates 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.
excludes No Allows specific values to be excluded from the picker selections
label No The visible label for the variable in the UI wizard. The format is typically a question like “Do you use product?”.
required No Indicates whether the variable value required in the UI. The default is false.
variableType No The variable type.

variableType Attributes

Attribute Required Description
dataType No Specifies 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.
fieldType No Specifies the field type for a CalculatedInsightsFieldType variable. Valid values are dimension and measure.
enums No Specifies a list of values for an enumerated variable type for a StringType or NumberType variable type.
enumsLabels No Specifies a list of labels for the enumerated values of a StringType or NumberType variable only.
itemsType No Specifies the items type for an ArrayType variable. The items type must be a valid variable type.
max No Specifies the maximum value for a NumberType variable only.
min No Specifies the minimum value for a NumberType variable only.
type Yes The type of the variable. Valid types are: <ul><li>ArrayType (Enumerated)</li><li>BooleanType (Enumerated)</li><li>CalculatedInsightFieldType (Object)</li><li>CalculatedInsightType (Object)</li><li>ConnectorType (String)</li><li>DataLakeFieldObjectType (Object)</li><li>DataLakeObjectType (Object)</li><li>DataModelFieldObjectType (Object)</li><li>DataModelObjectType (Object)</li><li>DatasetAnyFieldType (Object)</li><li>DatasetDateType (Object)</li><li>DatasetDimensionType (Object)</li><li>DatasetMeasureType (Object)</li><li>DatasetType (Object)</li><li>DateTimeType</li><li>NumberType (Enumerated)</li><li>SObjectFieldType (Object)</li><li>SObjectType (Object)</li><li>StringType (Enumerated)</li></ul>

See Also