Additional Configuration for Block Property Fields

You may use <uiconfig> as a child of <parameter> to provide additional configuration for one block property field in a custom block. You define a JSON configuration object in <uiconfig>.

Note:

It is a good practice to enclose the JSON code for <uiconfig> in a CDATA section to ensure there are no conflicts between the JSON and XML syntaxes.

In this context, the JSON object can include any configuration properties for the Ext.form.Field class, or a subclass you have specified, plus these additional properties specific to Business Analytics:

acceptedValues = an array of valid values for this field. Use this only when the datatype in <type> is enum. See Dynamic List Values from a Known Source for more information and an example.

datatype = the datatype for this field. This is identical to datatype for <type> and may have the same values. See <type> for details.

doNotStripNS = true or false. This is only applicable for block properties that return XPath expressions for a node that users select.

It is true by default, which returns XPath expressions that include a wildcard for potential namespaces for each node in the path. For example:

If you need to obtain an XPath expression that does not include namespaces, set this property to false.

label = the label for this property field. This is identical to <label> metadata within <parameter>.

This determines whether Wires treats this property as required for this custom block. It is identical to <required> metadata within <parameter>.

xpathPicker = a JSON object with additional properties that configure the Path Selection list for this block property. Configuration properties for the Path Selection list include:

combineWithUniversalPicker = true or false. This defaults to false. If true, the Path Selection list shows both this customized list and the default Path Selection list.

height = the number of pixels for the height of this list.

ignorePathToNode = true or false. This defaults to false. If true, this returns the value of the selected node rather than the path to the selected node.

neverHide = true or false. This defaults to false. If true, the Path Selection list remains open until users explicitly close it. This is typically used to allow users to select multiple nodes.

pathType = how namespaces should be handled in the XPath expression from the Path Selection list:

path = uses a wildcard character as the namespace for nodes in the XPath expression. This is the default.

pathWithActualNS = uses the actual namespace, if any, for nodes in the XPath expression.

pathWithoutNS = removes any namespaces for nodes in the XPath expression.

showOnlySelectablePaths = true or false. This defaults to false. If true, it causes the Path Selection list to show only those nodes that are valid to select. Typically, valid selections are determined by the datatype for the input parameter for this block property.

xpathPreferences = a JSON object with the following properties that identify what types of nodes are valid for user choices in the Path Selection list. Each property may be true or false: