SQUEAL Widget
 |
The SQUEAL widget is not available in 8.1 and later.
|
The SQUEAL ™ search widget is designed to allow a content developer to embed SQUEAL into a Mashup. The content developer can add hidden terms to the search using the search context property or by adding tags to the search in order to scope the search to the page contents. The search can also be scoped to a specific area or type of model entity.
You can trigger the search from another event in the mashup environment, or the user can launch the search process through the widget's built-in SQUEAL button.
Properties
For information about common widget properties, see Widgets. Properties that are specific to the SQUEAL widget are described in the table below.
|
Property Name
|
Description
|
Base Type
|
Default Value
|
Bindable? (Y/N)
|
Localizable? (Y/N)
|
|---|---|---|---|---|---|
|
Mode
|
Determines if you want to launch a generic SQUEAL search or if you want to search and retrieve the details for an entity in the ThingWorx model (SQUEAL Entity Detail Page)
|
STRING
|
SQUEAL Search
|
N
|
N
|
|
SearchTerm
|
The actual search term, which can be entered by the user at runtime or bound into the control
|
STRING
|
n/a
|
Y
|
N
|
|
SearchTermContext
|
An additional term to the search term that the content developer can add, which will be appended to the search at execution
|
STRING
|
n/a
|
Y
|
N
|
|
SearchArea
|
Search all or a specific subset of the ThingWorx model. The options are:
• All
• Things
• People
• Data
• Collaboration
• Mashups
• Tags
|
STRING
|
All
|
Y
|
N
|
|
ShowUiAtRuntime
|
Show or hide UI at runtime
|
BOOLEAN
|
true
|
N
|
N
|
|
SearchUsingStartsWith
|
Intelligently adds asterisks to make searching more natural and similar to SQUEAL
|
BOOLEAN
|
true
|
Y
|
N
|
|
TypeInfo
|
Type of entities on which to filter
|
STRING
|
n/a
|
Y
|
N
|
|
DataTags
|
Data tags on which to filter
|
TAGS
|
Tags
|
Y
|
N
|
|
ModelTags
|
Model tags on which to filter
|
TAGS
|
Tags
|
Y
|
N
|
|
Navigation
|
Determines if the widget brings up SQUEAL in a new window or sets the SQUEAL URL property
|
STRING
|
Window
|
N
|
N
|
|
SQUEALUrl
|
URL generated after SQUEALing. Used when the Navigation property is set to Set Url. Typically used with a Web frame control.
|
STRING
|
n/a
|
Y
|
N
|
|
ShowMessageIfNoEntity
|
Displays a message when the user navigates but no entity was selected.
|
BOOLEAN
|
false
|
N
|
N
|
|
MessageToShow
|
Message shown when the user navigates but no entity was selected.
|
STRING
|
Entity must be selected
|
Y
|
Y
|
Services
Squeal
Executes the call for the search function to return the entity detail page in a new window. The service can be called from any event within the Mashup environment.