Search Helper

What is it?

The Search Helper is a widget that is almost identical to the Input Box. The user can input multiple character strings into a single field, by separating them with a Delimiter such as Comma, Space, etc.

How and When to use it?

To add a new Search Helper to your page, simply drag and drop the “Search Helper” widget from the left side of the page screen to the design area of your page.

To change the name of the Search Helper, simply click on the search helper widget to reveal the blue quick-setting panel. The Name of the Search Helper is by default always shown on the left side of the widget.

How to configure it?

Click on the widget once to open its Quick Settings Panel.

Widget Property Settings

This window has four tabs, General, Value, Visibility and Calculation.

General

In the tab General, there are four subheaders: Basic, Configurations, Style, and “Position, Size and Layout.

Basic

The fields in “Basic” are Name, Display Name, and Description. If you leave the display name field blank when setting up your widget, the name field will automatically become the Display Name. If you fill in both fields, the system will use the Name field as an internal reference (like in page builder), while showing the display name to your users in Production.

Style

The options of Style are Show Label, Label Style, and Value Style. By default, Show Label is checked. If it is not checked, the left side of the widget that shows the widget name is removed and the field of the widget fills the entire widget area.

Label Style and Value Style both have the same Size and Alignment options. Label Style has one more field, Width, which is in units of pixels (px) and accepts a numerical value.

Position, Size and Layout

The fields in “Position, Size and Layout” are Sizing Mode, Position, and “Display in”. In Position, various parameters of the widget can all be adjusted precisely in units of pixel (px). These parameters change depending on what is selected in Sizing Mode.

In Relative Size, the right and bottom sides of the widget expand to completely fill the screen/window in Production.

The options of “Display in” are “Web & Mobile” (the default setting) and “Mobile Only”. It basically controls whether this label would be displayed on both platforms or not.

In Absolute Size, the dimensions of the widget are the same in the Page Builder and Production.

Configurations

PlaceHolder is the text displayed in the widget’s field when nothing has been entered.

In the "Search Type" option, you have the choice to select either "String" or "Numeric" as the type of data you want to enter in this widget.

In Production, the placeholder appears as grey text, only for display, and the end user cannot enter anything in the field

In Delimiter, you can choose the character used to separate character strings.

You can restrict the character length of entry in Maximum Length of Input.

There are only two options in the dropdown of “When Value Is From Other Page”, Normal and Looks Read-Only.

Value

In the "Value" tab, you can find two fields: "Default Value" and "Page Data Source". The "Default Value" field is where you can enter a value that will be displayed if the user hasn't entered anything yet. On the other hand, the "Page Data Source" field cannot be edited by default.

Visibility

In the single-column table, you can turn on/off the ‘Invisible’ and ‘Looks Read-Only’ options for your widget. The first entry is the default setting that applies to everything. You can also create new entries by tapping ‘New Conditional Visibility’ and setting a condition with two operands and an operator in between, so the rule will only apply when the condition is met.

Tap the blue edit button to apply multiple conditions for conditional visibility.

A popup window called Condition Settings appears after clicking.

Calculation

In the Calculation Tab, there are three fields, Mode, Default formula, and + New Conditional Formula.

(The red stars indicate which fields are mandatory.)

There is no conditional formula by default, the user must click on the area “+ New Conditional Formula” to add one.

It is mandatory to fill in the Default formula, which is blank by default if there is at least one conditional formula.

There are five types of items that can be entered into a formula: Text, Date & Time, Variable, Function and Widget.

Text

Text is a user-created string that can contain any kind of character, such as a number, punctuation, etc.

Date & Time

Date & Time opens a calendar and clock for the user to choose a fixed DateTime value.

Variable

Variable opens a list of unique system variables.

Function

Function opens a list that contains two kinds of items:

1. Mathematical notation: Plus/minus symbols and parentheses which are used normally in operations such as between and around items

2. Functions: After making a selection, you may notice that it appears with a set of parentheses at the end. In order to use the function correctly, you need to enter the appropriate expression with the correct parameters inside those parentheses.

Widget

Widget opens a list of widgets on the same page.

If there is a form widget on the page, you will find the unique key of the form available for selection at the top of the list. The name of the form is indicated by the widget name inside parentheses, such as "(Form)”

How to set up a conditional formula?

The Conditional Formula works very similarly to the Default Formula. To define the condition for the conditional formula, you need to specify two operands and an operator, which can be edited in the top row of the field. If you want to use multiple conditions within a single conditional formula, simply click on the blue edit button located to the right of the top row.

A popup window called Condition Settings appears after clicking.

How to look up all the variables and functions?

Tab the blue question icon to open the calculation description manual.

A PDF File with the title “Calculation Description” will appear.

Widget Permission Settings

You will find the “User role” tab.

In the table, you will see the name of each Runtime User Role listed on the left. On the right side of each entry, there's a handy dropdown menu that lets you choose the level of access that each Role has to the widget in Production.

If you choose the 'Inherit' option, the Role Privileges that you have set in the Runtime User Roles List will be applied.

Copy Widget Settings

In the popup window, you can selectively copy the values of each field in Widget Property Settings to the same fields of one or multiple widgets, even widgets inside of Forms and inside of other widgets.

The left side shows all of the fields of the Source Widget. The top of the left side shows all of the tabs of Widget Property Settings.

The right side is a list of the names of all widgets other than the source widget on the same Page.

You can click Close on the top right to exit or click Apply on the bottom right to apply changes.

Remove

If you click the delete button, a popup message will appear asking for confirmation before the widget is deleted. You can either click delete or cancel to leave without changing anything.