List Box ToolList Box ToolList Box tool will display a multi-selection check box list in an app or macro. The selections specified by the user are passed as values to downstream tools.
Example of a List Box:
Enter the text or question to be displayed: The text here will be presented to the user instructing them how to use the List Box control.
All Checked by Default: when checked, all items in the list box will be selected (checked) for the user.
Select the mode in which this control should behave. Choices are:
Select tool Mode: Use this option when updating a Select tool.
Generate custom list: Not visible to the App Consumer, this option returns a list of the selected values with the specified Start, Separator, and End characters. This option is usually used in tandem with the List Values: "External Source" or "Manually set values" described below.
See an example of the Generate
custom list here.
The List Box tool configuration set to Generate Custom List.
This is how the Question appears to the user:
And the returned values look like:
<WizardValues ShowDebugMessages="False">
<Value name="ListBox(1)">"01","02","04"</Value>
</WizardValues>
List Values: Drop down selection determining how the list is populated. Options are explained in detail below:
Field Types: The list is populated with the Designer-supported field types.
External Source: The list is populated with values pulled from an external file or database connection.
Properties
Specify the file location of the External Source File.
Format the file to contain the Name and Value fields in the following configuration.
| Name | Value |
|---|---|
| Alabama | 01 |
| Alaska | 02 |
The end user selects from the list populated with Names and the corresponding Value is passed downstream. The file can be a relative path to the saved workflow, but the end user must have the external source file saved to the same path.
Fields from Connected Tool: The list is populated with the fields found in a connected tool. A tool must be connected to the optional input anchor.
Properties
Show only fields of the following types: Select the field types to populate the list for end user selection.
Include [None]: Include "None" as a valid end user selection.
Manually set values: The list is populated by values entered manually by the App or macro creator.
Properties
Type one data pair per line in the format Name:Value. If no Value is specified, Name is returned as the Value.
Alteryx can work with a number of installed datasets. The following options cause the end user's selection list to populate with the available respective datasets. No additional configuration is required.
If the user does not have access to a dataset, the app or macro still successfully runs. However, the workflow errors.
File Browse in this Analytic App/Macro: The list is populated with the fields found in the connected File Browse Tool. A File Browse interface tool must be connected to the optional input anchor.
Properties
Show only fields of the following types: Select the field types to populate the list for end user selection.
Include [None]: Include "None" as a valid end user selection.
Fields from Macro Input: The list is populated with the fields found in the connected Macro Input Tool. A Macro Input tool must be connected to the optional input anchor.
Properties
Show only fields of the following types: Select the field types to populate the list for end user selection.
Include [None]: Include "None" as a valid end user selection.
©2017 Alteryx, Inc., all rights reserved. Allocate®, Alteryx®, Guzzler®, and Solocast® are registered trademarks of Alteryx, Inc.