Dropdown Component

Label Text                                                                        

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Placeholder Text                                                                        

A short prompt telling end-users the expected value of an input field. For example, Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.

Tooltip                                                                        

A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.

Hide Label                                                                        

Setting Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder.

By default, this setting is set to (OFF).

Hide Field                                                                        

Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.

By default, Hide Field is set to (OFF).

Input Behavior                                                                        

Controls how end-users interact with the component. Choose from the following options:

• Enable User Input: Allow end-users to view and enter data in this field.

• Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

• Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

• Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.

• Triggering a module save event using a Button component with an Action Type of Save.

• Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

  By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to (OFF) when you don’t want to store the values from this field in the database.

When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.

Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Option Label                                                                        

Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.

After you create an option, another row displays for you to create the next option.

Data Source Values                                                                        

Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.

By default, the value is a camel case version of the Option Label. You can also assign a numeric value to each option for use in logic-based configurations.

Request Header                                                                        

Enter the information to display in the drop-down selections. These are your end-user's options. For external APIs, you'll find this information in the API documentation. To pull data from a Data Collection, enter the column header you want to use.

Option Value                                                                        

Each option needs an associated value to store in the submission data. Enter the values to store in submission data using this column.

By default, the value is a camel case version of the Option Label. You can also assign a numeric value to each option for use in logic-based configurations.

Data Source URL                                                                        

For an API to retrieve data, you need the API's URL information. In this field, enter the API information as obtained from the API documentation. Add additional filters at the end of the URL if you want to drill down to a specific type of data.

Data Path                                                                        

If using an API call to populate the component, enter a specific data property to reference here. This is useful if you want to show one piece of a larger data set in your Dropdown component.

Filter Query                                                                        

Provide additional filtering using query parameters. Parameters append to the end of the Data Source URL. Query parameters can be static or dynamic. For example, name={{data.groupName}}.

Value Property                                                                        

If a data set includes a column for values, enter the column's name here.

If not specified, the application uses the option label itself.

Label Path                                                                        

This field refers to the option labels you want to pull. Enter the option label's column header in this field.

Refresh On                                                                        

This field displays a list of the other components in your module. You can select a component here to refresh your Dropdown. When your end-user interacts with the selected component, the Dropdown resets.

You can also select Any Change. This refreshes the Dropdown if your end-user interacts with any of your components.

This setting watches other components in your module. The more components the component watches, the more performance issues can occur. It’s also important to note that processes large amounts of data on the client side will also impact performance.

Require Search Parameters                                                                        

When set to (ON), search parameters must be present to execute the search.

By default, this setting is (OFF).

Clear Value on Refresh                                                                        

When set to (ON), the selected value is cleared after the Refresh On setting triggers.

By default, this setting is (OFF).

Authenticate                                                                        

When set to (ON), authentication headers from the application are sent to the Data Source URL destination.

By default, this setting is (OFF).

Data Reference Key                                                                        

Enter the Property ID of the component whose data you're referencing.

Value Property                                                                        

If a data set includes a column for values, enter the column's name here.

If not specified, the application uses the data drawn using the Label Path setting below.

Label Path                                                                        

This field refers to the option labels to retrieve. If you're retrieving data from a Data Table component, enter the column header in this field.

Refresh On                                                                        

This field displays a list of the other components in your module. You can select a component here to cause your Dropdown to refresh. When your end-user interacts with the selected component, the Dropdown resets.

Here, you can also select Any Change. This refreshes the Dropdown if your end-user interacts with any of your components.

This setting watches other components in your module. The more components the component watches, the more performance issues can occur. It’s also important to note that processes large amounts of data on the client side will also impact performance

Trigger                                                                    

To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires.

Required                                                                    

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

By default, Required is set to (OFF).

Required Error Message                                                                    

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Custom CSS Class                                                                    

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.