Mashup Builder > Mashups > Configuring Mashup Parameters
Configuring Mashup Parameters
You can create and configure parameters for your mashups. These parameters are bindable sources and targets that have a Parameter Value Changed event. The following fields are available to configure mashup parameters:
Name: The name of the parameter.
Base Type:
Field Definition Base Types
Base Type
A true or false value.
The name of a dashboard.
A reference to a Data Shape in the model, and therefore has special handling.
A formatted date and time.
Some HTML content.
A standard URL (e.g.,
Binary data that can be rendered as an image.
A URL link to an image.
A standard representation of data in ThingWorx that is similar to a SQL result set. There are a number of built-in services for building, consuming, and parsing an infotable.
A number that can be written without a fractional component.
A JavaScript object notation string.
For ThingWorx 8.4.0 and higher versions.
Standard World Geodetic System (WGS) 84 coordinate, expressed as [longitude, latitude], elevation.
The LONG type should be used when a range longer than the INTEGER base type provides is required.
A reference to a ThingWorx mashup, and therefore has special handling.
Contains nothing (void).
A number.
Exponential values are allowed. For example, 123e45.
A masked password value. See Passwords for more information. For information about encryption methods, see Encryption.
A JSON object that includes an array of "filters.” Each filter should include "value," "type,” and "fieldname".
A cron based schedule (configured using the Schedule Editor).
Any amount of alpha numeric characters.
A reference to a style theme and therefore has special handling.
ThingWorx tag values.
Any amount of alpha numeric characters. The difference with Strings is that TEXT is indexed.
A reference to a Thing and therefore has special handling.
A reference to a Thing Shape in the model, and therefore has special handling.
The name of a Thing Template.
A TimeSpan object represents a time interval (duration of time or elapsed time) that is measured as a positive or negative number of days, hours, minutes, seconds.
A reference to a ThingWorx user defined in the system.
An XML snippet or document.
Binding Direction: Source, Target, or Both.
Tooltip: Text that is added to the mashup parameter as a tooltip when it is hovered over.
Add to Reminders: If selected, displays reminders that additional steps are required to configure the parameters in the contained mashup.
Delete: Removes the mashup parameter.
The following enhancements are done to configure the mashup parameters:
You can set the base type to JSON type.
This capability brings a lot of flexibility to advanced developer. JSON editor is provided to allow the user to type JSON.
You can assign INFOTABLE type to a parameter without assigning the Data Shape. This you allows to provide different Data Shapes to the mashup.
You can control the binding direction of the parameter : “←”(Source), “→” (Target), and “↔” (Both).
You can add a reminder to the Reminders panel for each parameter.
When a parameter is in a Contained Mashup widgets, a hint is displayed in the Reminders panel.
After you drag a mashup to a Contained Mashup widget, the parameters become available in the property panel of the Contained Mashup widget, and the following capabilities are available to you:
You can send a JSON string to the Contained Mashup widget. JSON editor is provided to allow the user to type JSON.
You can send an infotable without a predefined Data Shape to the contained mashup parameter.
You can easily understand what is the binding direction of the parameter for the Contained Mashup: “←”(Source), “→” (Target), and “↔” (Both).
You can see a reminder for the parameter.
For example, for the following parameters in the image;
The result expected in the Contained Mashup widget is as follows:
Was this helpful?