Configuration Parameters Table

3.5 Reference table for all data source configuration parameters

The following reference table lists all available configuration parameters for a data source template. Parameters are grouped into tabs by category. Click a tab to browse that category, then click any parameter to expand it and see the full details.

Each parameter shows:

• Type — the data type expected, e.g. string, boolean, object
• Required — whether the parameter must be included
• Default — the value used if the parameter is not specified
• Purpose — what the parameter does
• Example — an example value where applicable

Top Level

url — string | Required: Yes

Purpose: Defines the base URL for the API request, supporting path parameters wrapped in {{}}.

Example: "https://api.carbonintensity.org.uk/generation", "https://dummyjson.com/products/{{num}}"

type — string | Required: Yes

Purpose: Defines the HTTP method used for the request.

• GET — data is sent as part of the URL in query parameters
• POST — data is sent in the request body
• POST_FORM — content sent as a form rather than a JSON object

Example: "GET", "POST"

transform — string | Required: No

Purpose: Specifies an optional transformation function to apply to input or output data.

Example: "transformHistorianMultiValueInputs", "transformHistorianMultiChartInputs"

useProxy — boolean | Required: No | Default: false

Purpose: Indicates whether the API request should be sent via the built-in proxy server. Must be true if authentication is set in the headers section to avoid CORS errors.

Example: true, false

compatibleWith — array | Required: Yes

Purpose: Defines the types of components that can use the data from this data source.

Example: ["table"], ["chart", "value"]

trendWith — string | Required: No

Purpose: Optional data source ID of a data source with a trendable version of the parameter.

Example: "historian-multi-chart"

batchSize — number | Required: No

Purpose: Specifies the batch size for requests.

Example: 100

isTrendable — boolean | Required: No | Default: false

Purpose: Indicates if the data from this source can be used in trends.

isWriteable — boolean | Required: No | Default: false

Purpose: Indicates if data can be written back to this source.

isUnique — boolean | Required: No | Default: false

Purpose: Indicates if the data should be unique.

concurrentSize — number | Required: No

Purpose: Specifies the number of concurrent requests.

writeWith — string | Required: No

Purpose: Specifies another data source ID to use for writing data.

function — string or function | Required: No

Purpose: An optional function to be executed for data retrieval or transformation.

Example: 'staticChart'

Inputs

inputs[].name — string | Required: Yes

Purpose: A machine-friendly name for the input.

Example: "AIRPORT_CODE", "tag", "num"

inputs[].type — string | Required: Yes

Purpose: Specifies where the input parameter should be placed in the request.

• url — substituted into the URL path e.g. foo.io/{{bar}}
• get — appended to the URL as a query parameter
• body — used with POST_FORM
• json — used with POST
• header — substituted into the request headers

Example: "url", "get", "header"

inputs[].parameterName — string | Required: Yes

Purpose: The name of the parameter as it appears in the URL or request body.

Example: "arr_iata", "timeZone"

inputs[].label — string | Required: No

Purpose: A user-friendly label displayed above the input field in the UI.

Example: "3 letter airport code, e.g. LGW or JFK", "Tag"

inputs[].default — string | Required: No

Purpose: The default value to use if the user does not provide an input.

Example: "json", "now", "1"

inputs[].format — object | Required: No

Purpose: Defines the format of the input value, especially useful for dates.

Property	Description
type	The data type, e.g. "date"
pattern	Format pattern, e.g. "yyyy-MM-dd'T'HH:mm:ssXX"
timeZone	Timezone, e.g. "CEST"

inputs[].isRequired — boolean | Required: No | Default: false

Purpose: Indicates if this input is mandatory.

inputs[].isAdvanced — boolean | Required: No | Default: false

Purpose: If true, the input is hidden under an “Advanced” section in the UI.

inputs[].isChartStart — boolean | Required: No | Default: false

Purpose: If true, this input will use the chart’s start time. Only one input can have this set to true. See isChartEnd for usage.

inputs[].isChartEnd — boolean | Required: No | Default: false

Purpose: If true, this input will use the chart’s end time. Only one input can have this set to true. For charts/tables, any isChartEnd input will be set to the End value in the widget’s live options.

inputs[].isHidden — boolean | Required: No | Default: false

Purpose: If true, the input is not visible in the UI but is still configurable during installation.

inputs[].isConfigurable — boolean | Required: No | Default: false

Purpose: If true, this input is shown during data source installation for one-time configuration.

inputs[].isCode — string | Required: No

Purpose: If set to "sql", displays an SQL formatted text box for user input.

inputs[].multi — boolean | Required: No | Default: false

Purpose: Indicates if multiple values can be selected for this input.

inputs[].encode — boolean | Required: No | Default: false

Purpose: Indicates if the input value should be URL-encoded.

inputs[].transform — string | Required: No

Purpose: Specifies a transformation to apply to this input.

Example: "transformSmartdashInput"

inputs[].showBasket — boolean | Required: No | Default: false

Purpose: If true, this input can be added to the basket for bulk actions.

inputs[].showTagEdit — boolean | Required: No | Default: false

Purpose: If true, displays a search icon for searching tags.

inputs[].showStaleAfter — boolean | Required: No | Default: false

Purpose: Enables a staleness indicator on components using this data, useful for live or frequently changing data.

Outputs

output.paths[].name — string | Required: Yes

Purpose: The human-readable name for the output field.

Example: "biomass", "value", "x"

output.paths[].path — string | Required: Yes

Purpose: The JSONPath expression to locate the desired value in the API response.

Example: "$.data.generationmix[?(@.fuel === 'biomass')].perc"

output.paths[].type — string | Required: No

Purpose: The data type of the output value.

Example: "date"

output.paths[].label — string | Required: No

Purpose: Helpful text shown to the user for this output field.

output.paths[].default — string | Required: No

Purpose: The default value if no value is found in the API response.

output.paths[].format — object | Required: No

Purpose: Defines the format of the output value, especially for dates.

Property	Description
type	The data type, e.g. "date"
pattern	Format pattern, e.g. "yyyy-MM-dd'T'HH:mm:ssXX"

output.transform — string | Required: No

Purpose: Specifies a transformation function to apply to the output data.

Example: "transformSmartdash", "transformHistorianMultiValue"

Headers & Errors

headers — object | Required: No

Purpose: Key-value pairs representing custom headers to be included in the API request.

Example: {"Authorization": "..."}, {"Content-Type": "application/json"}

headers.Authorization — string | Required: No

Purpose: Authorization header value. Must be base64 encoded. See base64encode.org.

errorPath — object | Required: No

Purpose: Defines the path to error information in the API response.

Example: {"message": "$.error.message"}

errorPath.label — string | Required: No

Purpose: Helpful text for the error message field.

errorPath.message — string | Required: Yes

Purpose: The JSONPath to the error message in the response.

Example: "$.error.message"

Metadata

Metadata.Name — string | Required: Yes

Purpose: The user-friendly name of the data source shown to users.

Example: "UK Carbon Intensity", "Eigen Ingenuity Historian"

Metadata.nameID — string | Required: Yes

Purpose: The machine-friendly name used by the code. Should not contain spaces.

Example: "uk-carbon-intensity", "eigen-historian"

Metadata.Description — string | Required: Yes

Purpose: A detailed explanation of the data source, including any limitations such as request limits.

Example: "Queries the UK carbon intensity API..."

Metadata.Image — string | Required: No

Purpose: Optional image to help users identify the data source. Configured automatically by the Upload Image wizard. Accepts png, jpg or svg.