Template Configuration Resource

• Aura — <wave:sdk> getTemplateConfig()

The following JSON is an example response body.

1{
2  "ui": {
3    "pages": [
4      {
5        "title": "Application Preferences",
6        "variables": [
7          "lensDashboardName",
8          "dashboardHeader"
9         ]
10      },
11      {
12      "title": "Other preferences",
13      "variables": [
14        "emailNotifications",
15        "emailAddress"
16       ]
17      }
18    ]
19  },
20  "variables": {
21    "numberPicked": {
22      "defaultValue": 3,
23      "description": "A number between 1 and 10.",
24      "excludeSelected": false,
25      "excludes": [],
26      "label": "Please pick a number between 1 and 10?",
27      "required": true,
28      "variableType": {
29        "enums": [],
30        "max": 10,
31        "min": 1,
32        "type": "NumberType"
33      }
34    },
35    "lensDashboardName": {
36      "defaultValue": "My View of Election Data",
37      "description": "The name of the sample lens.",
38      "excludeSelected": false,
39      "excludes": [],
40      "label": "What would you like to name your lens and dashboard?",
41      "required": true,
42      "variableType": {
43        "type": "StringType"
44      }
45    },
46    "dashboardHeader": {
47      "defaultValue": "Wow! Interactive Dashboards are Nice!",
48      "description": "The dashboard header.",
49      "excludeSelected": false,
50      "excludes": [],
51      "label": "What would you like the dashboard header to say?",
52      "required": true,
53      "variableType": {
54        "enums": [],
55        "type": "StringType"
56      }
57    },
58    "emailNotifications": {
59      "defaultValue": "Yes",
60      "description": "Email notifications",
61      "excludeSelected": false,
62      "excludes": [],
63      "label": "Would you like to receive emails for promotions?",
64      "required": false,
65      "variableType": {
66        "enums": ["Yes","No"],
67        "type": "StringType"
68      }
69    },
70    "emailAddress": {
71      "defaultValue": null,
72      "description": "Your email address.",
73      "excludeSelected": false,
74      "excludes": [],
75      "label": "Please enter your email address?",
76      "required": false,
77      "variableType": {
78        "enums": [],
79        "type": "StringType"
80      }
81    }
82  }
83}

UiDefinitionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
display​Messages	Display​Message​Representation[]	The display messages for this template configuration.	Small, 36.0	36.0
pages	Page​Representation[]	The page collection for this template configuration.	Small, 36.0	36.0

DisplayMessageRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
location	String	The name of the page where the text is to be displayed.	Small, 36.0	36.0
text	String	The text content to display.	Small, 36.0	36.0

PageRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
condition	String	The optional condition to determine if the page is visible or not. Values are client-side EL notation (such as {{Variables.selectedOption}}).	Small, 36.0	36.0
help​Url	String	A URL to this page's help webpage.	Small, 36.0	36.0
title	String	The title for the page.	Small, 36.0	36.0
variables	Page​Variable​Representation[]	The collection of variables for this template configuration.	Small, 36.0	36.0
vfPage	Asset​Reference​Representation	The Visualforce page to be used as the wizard user interface instead of the standard wizard interface.	Small, 40.0	40.0

PageVariableRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
name	String	The name of a variable.	Small, 36.0	36.0
visibility	String	The visibility expression for this variable	Small, 36.0	36.0

VariableDefinitionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
computed​Value	Object	The computed value of the variable. This value is set by integrated apex implementations.	Small, 38.0	38.0
default​Value	Object	The default value of the variable.	Small, 36.0	36.0
description	String	The description of the variable.	Small, 36.0	36.0
exclude​Selected	Boolean	Indicates whether this variable excludes already selected values or not.	Small, 36.0	36.0
excludes	String[]	The list of values to exclude from the variable selection.	Small, 36.0	36.0
label	String	The label for the variable.	Small, 36.0	36.0
most​Recent​Value	Object	The value specified in the most recent app creation process.	Small, 36.0	36.0
required	Boolean	Indicates whether the variable is required or not.	Small, 36.0	36.0
variable​Type	Variable​Type​Representation	The type of the variable. Valid variable types are: Array​Type​Representation Boolean​Type​Representation ConnectorTypeRepresentation Dataset​Any​Field​Type​Representation Dataset​Date​Type​Representation Dataset​Dimension​Type​Representation Dataset​Measure​Type​Representation Dataset​Type​Representation Date​Time​Type​Representation Number​Type​Representation Object​Type​Representation SObject​Field​Type​Representation SObject​Type​Representation String​Type​Representation	Small, 36.0	36.0

ArrayTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in ArrayTypeRepresentation alongside the properties defined explicitly in the following table.

BooleanTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in BooleanTypeRepresentation alongside the properties defined explicitly in the following table.

ConnectorTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in ConnectorTypeRepresentation alongside the properties defined explicitly in the following table.

DatasetAnyFieldTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

DatasetDateTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

DatasetDimensionTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

DatasetMeasureTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

DatasetTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

DateTimeTypeRepresentation inherits properties from the abstract VariableTypeRepresentation.

NumberTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in NumberTypeRepresentation alongside the properties defined explicitly in the following table.

ObjectTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

SObjectFieldTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation. These base properties appear in SObjectFieldTypeRepresentation alongside the properties defined explicitly in the following table.

SObjectTypeRepresentation inherits properties from the abstract BaseObjectTypeRepresentation.

StringTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in StringTypeRepresentation alongside the properties defined explicitly in the following table.

BaseObjectTypeRepresentation inherits properties from the abstract VariableTypeRepresentation. These base properties appear in BaseObjectTypeRepresentation alongside the properties defined explicitly in the following table.