<property>
A property of an app or of a complex object for a topic payload.
Can Contain | ( <property> | <properties> )* |
Allowed In | <app>, <properties> or <property> (only within <topic>) |
Attributes
Name | Required | Description |
datatype | yes | The datatype for this property. This defaults to string. Valid datatypes include:  stringnumber boolean date timestamp = currently only available within topic payloads enum = an enumerated list of valid values. You set the values that users can select from in the possiblevalues attribute. any = any valid datatype is accepted for this property. object = a complex property only allowed within topic payloads. This is the default type for topic payloads. |
defaultvalue | | An optional default value to use for this property if it is not otherwise specified. |
isinput | | Determines whether this property is treated as an input parameter for the app (true). This defaults to false. |
label | | An optional label to display to users for this property. Note: | Business Analytics displays labels for properties in the input parameter forms that are generated for basic apps and also when users edit app properties in Business Analytics. |
|
name | yes | The name of this property. |
possiblevalues | | A short list of a valid values, separated by commas, for this property. This only applies if datatype = ’enum’. Note: | Business Analytics uses and enforces valid value lists for properties only in the input parameter forms that are generated for basic apps or when users edit app properties in Business Analytics. |
|
required | | Determines whether this property must be supplied true or not for the app to run successfully. This defaults to false. Note: | Business Analytics enforces required values for properties only in the input parameter forms that are generated for basic apps. |
|
tooltip | | A short, optional description to use as a tooltip or hint to users for this property. Note: | Business Analytics displays tooltips for properties in the input parameter forms that are generated for basic apps. |
|
validation | | For string properties, the basic validation rules to apply when users enter a value. Valid validation rules include: any = no validation is applied. This is the default. alphanumeric = must be an alphanumeric character. alpha = must be an alphabetic character. numeric = must be a number. Note: | Business Analytics enforces validation only in the input parameter forms that are generated for basic apps. |
|
visibility | | Can be visible, read-only or hidden. This determines visibility and user access to a property, in combination with the isinput attribute in several different contexts. See Controlling Property Access and Visibility for details. |
Controlling Property Access and Visibility
Whether a property is considered an input parameter for the app and its visibility affects whether the property can appear in the input form for the app. It also affects whether it can be used in wiring interactions between apps in workspaces created in Mashboard and whether the property can be saved as a preference for user favorites in the AppDepot.
Note: | These attributes do not control programmatic access to app properties. |
To enable the use of a property in:
App Input Forms: set
isinput = true and
visibility = visible.
With input forms, users can change the property whenever they want to. However, users cannot save their preferences with a new favorite copy of an app in AppDepot.
Wired Workspace Interactions: set
isinput = true and
visibility = visible.
Note: | In earlier releases, this use required that the property have its visiblity hidden. This is no longer required. Instead, you can hide input forms for apps in workspaces in Mashboard. See Hiding Input Forms for Apps in a Workspace for instructions. |
Saved Preferences for Favorites in AppDepot: set
isinput = true and
visibility = visible.
Users can update a property when they mark an app as a favorite in AppDepot and save that update as a ’personal copy’ with a different name. When they use this favorite, the saved preferences are automatically applied.
Note: | In earlier releases, this use required that the property have its visiblity hidden. This is no longer required. |
Use Default Only, Either Hidden or Read-Only: to omit the property from input forms, wiring, or any customization, set
isinput = false. Then use
visibility to make the property completely hidden or read-only
