Checkbox ETL Inject

Description

This inject control is commonly used to pass a value in document structure to other Ambience components as a child element of $elx-etl-inject. This has one input field that allows multiple options to be selected when used on the Viewer. A checkbox corresponds to each option. Selected values are passed in this format:

{
<Inject Field> : <array of the options selected>
}

Sample:

{
educationlevel : ["High School Degree", "Partial College"]
}

This is suitable for string-type fields (field identified for Filter) with not so many options that also require multiple values to be selected at a time.

Viewer Usage

To select an option, simply select the checkboxes corresponding the value. Multiple options can be selected.

There are shortcut buttons that provide convenience in controlling the selected values.

Clicking on the “Deselect All” icon deselects all the options.

Clicking on the “Invert Selection” icon inverts the selected options. This means that all options that are selected become deselected. Likewise, all options that are deselected become selected.

Specific Properties

Below are the fields that are specific to this control:

Field Description Mandatory Input Type Constraints Default Value
Dataset Name of the dataset that contains the data to be used as the control’s selector options. Y Select One value can be selected. All enabled datasets are available options. None
Subset Subset of the dataset selected. N Select One value can be selected. All enabled subsets of the selected dataset. The dataset must be selected first. None
Filter Field of the selected dataset which contains the values to be used as the control’s selector options. Y Select One value can be selected. All fields of the selected dataset/subset combination. The dataset and subset (optional) must be selected first. None
Initial Values Determines the initial set or selected values upon loading in the Dashboard Viewer. Y Select One value can be selected. Available options are:

- None (all options are deselected)

- First (only the first displayed option is selected)

- Last (only the last displayed option is selected)

- All (all of the options are selected)

- Values (all comma-separated values entered in the field that appears below this property; spaces are allowed before and after the comma)

“None”