Complex variables.json Variable Types

Complex variable types are unique to Salesforce, for example, sobject, sobjectField. Use them to query the org for access to data from Salesforce objects. Scroll to the right to view example values. Examples for each type appear below the chart.

References an sObject within your org.

References a field within an sObject.

"variableType" : { "type": "SobjectFieldType", "dataType":"xsd:double" }

The dataType limits values for sObjectField. For example, specify xsd:double to limit the list of fields to numeric sObject fields only. See Primitive Data Types in the Salesforce Object Reference for more values for dataType.

References a connector within your org to use for recipes or dataflows. For more information, see Add a Remote Connector to a CRM Analytics Template.

"variableType" : { "type": "ConnectorType" , "connectorType" : "SalesforceExternal" }

References a dataset within your org.

"variableType" : { "type": "DatasetType" }

References a dimension within a dataset. Use to let app creators select dataset dimension fields to populate app dashboards. Requires that a DatasetType variable is set so datasetId is referenced at runtime.

"variableType" : { "type": "DatasetDimensionType" }

References a measure within a dataset. Use to let app creators select dataset measure fields to populate app dashboards. Requires that a DatasetType variable is set so datasetId is referenced at runtime.

"variableType" : { "type": "DatasetMeasureType" }

References a date within a dataset. Use to let app creators select dataset date fields to populate app dashboards. Requires that a DatasetType variable is set so datasetId is referenced at runtime.

"variableType" : { "type": "DatasetDateType" }

References any type of field within a dataset. Use to let app creators select dataset dimensions, measures, and dates to populate app dashboards from a single list. Requires that a DatasetType variable is set so datasetId is referenced at runtime.

"variableType" : { "type": "DatasetAnyField" }

References a time and date. Can’t be used in non-VisualForce page in ui.json. Value must be an ISO 8601 formatted date time string, as per RFC 3339, section 5. For example, 2020-02-19T14:31:42-0700.

"variableType" : { "type": "DateTimeType" }

References a user-defined object in your org. ObjectType isn’t supported in the UI and referencing it in ui.json results in app creation errors. Use ObjectType for runtime functionality, such as Overrides.

"variableType" : { "type": "ObjectType" }

References a data lake object within your org.

"variableType" : { "type": "DataLakeObjectType" }

References a field within a data lake object.

"variableType" : { "type": "DataLakeObjectFieldType", "dataType":"number" }

The dataType limits values for dataLakeObjectField. For example, specify number to limit the list of to numeric fields only. Valid values are number string, date, date_time, or null for all values.

References a data model object within your org.

"variableType" : { "type": "DataModelObjectType" }

References a field within a data model object.

"variableType" : { "type": "DataModelObjectFieldType", "dataType":"string" }

The dataType limits values for dataModelObjectField. For example, specify string to limit the list to string fields only. Valid values are number string, date, date_time, or null for all values.

References a calculated insight within your org.

"variableType" : { "type": "CalculatedInsightType" }

References a field within a calculated insight.

"variableType" : { "type": "CalculatedInsightFieldType", "dataType":"dimension" }

The dataType limits values for calculatedInsightField. For example, specify dimension to limit the list of dimension fields only. Valid values are dimension measure, date, date_time, or null for all values.

The variables.json file generated upon template creation contains an Overrides variable for app assets. Overrides are referenced in template-info.json as a conditional for whether assets are created at runtime or not. It’s best practice to edit Overrides. Overrides can be removed as long as all references to Overrides are also removed from template-info.json.