This section will explain all the available controls for the user to use in their DXFs, every control will have a small explanation, a self contain example that can be run in the the DXF Development Tool, a display example, and the resulting configuration.
Can only be use inside another dxf control. Display a question mark
right next to the control with helpful information.<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <string display="control" type="string"> <dxf:help>Help Tooltip</dxf:help> </string> </properties> </dxf:template>
Displays a message in the configuration.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
subType | String | info | yes |
| Indicates the type of message to display |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:annotation subType="tip"> Tip type annotation </dxf:annotation> <dxf:annotation subType="info"> Info type annotation </dxf:annotation> <dxf:annotation subType="note"> Note type annotation </dxf:annotation> <dxf:annotation subType="warning"> Warning type annotation </dxf:annotation> </properties> </dxf:template>
<properties> </properties>
These headers display header text in the form. They are for display only, they have no affect on the XML output.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:h1>Header 1</dxf:h1> <dxf:h2>Header 2</dxf:h2> </properties> </dxf:template>
<properties> </properties>
Displays a horizontal rule in the form. This is for display only, it has no affect on the XML output.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:hr/> </properties> </dxf:template>
<properties> </properties>
Copies an HTML <br/> tag to the output. This may be useful for adding space after other UI widgets.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:hr/> <dxf:hr/> <dxf:br/> <dxf:br/> <dxf:hr/> </properties> </dxf:template>
<properties> </properties>
Groups a set of components in a same category
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
legend | String | info | yes | - | Indicates the type of message to display |
collapse | boolean | false | yes | - | Enables the option to collapse the fieldset |
isCollapsed | boolean | false | yes | - | Indicates if the fieldset will be collapse on display |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:fieldset legend="Legend" collapse="true" isCollapsed="false"> <dxf:h1>Inside the Fieldset</dxf:h1> </dxf:fieldset> </properties> </dxf:template>
<properties> </properties>
The "constant" type displays no user interface control at all, but merely copies it's data directly to the XML output. It is primarily useful inside the "dxf:alternatives" tag below, so that different alternatives can copy different constant values to the output.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
visible | boolean | false | yes | - | Indicates is the constant will appear in the configuration, |
display | String | - | yes | - | The label to be displayed for the user before the control, if the constant is visible. |
help | String | - | yes | - | Adds a tooltip, if the constant is visible. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <constant type="constant" visible="true" help="Help for the constant control." display="Constant">ABCD</constant> </properties> </dxf:template>
<properties> <constant>ABCD</constant> </properties>
A simple text-entry box.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | String | - | yes | - | The default value to display if none is provided in the initialization data. |
allowEmptyString | boolean | false | yes | - | When true, the element is created (with an empty string) when there's no text data entered by the user. If false, the XML element will be entirely removed from output XML when there's no string entered. |
placeholder | String | - | yes | - | Adds a placeholder to the text field to show the user what is expected on this field. If no placeholder is specified, the default will be the placeholder |
validations | String | - | yes |
| Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces. |
protocols | String | - | yes | - | Indicates which protocols can be used for this field. This attribute only can be used with the url validation. |
regex | String | - | yes | - | Indicates what regex is going to be used as a validation for this field. This attribute can only be used with the regex validation. |
min | integer | - | yes | - | Sets a minimum of characters allow. |
max | integer | - | yes | - | Sets a maximum of characters allow. |
trim | boolean | true | yes | - | If disable it will leave any white space at the beginning and the end of the value |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <string display="String" type="string" placeholder="placeholder"> <dxf:help>Help for the string control.</dxf:help> </string> </properties> </dxf:template>
<properties> <string>Default</string> </properties>
A string entry control for entering and encrypting passwords. Text entered into this control is automatically sent to Aspire to be encrypted using the master password.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
allowEmptyString | boolean | false | yes | - | When true, the element is created (with an empty string) when there's no text data entered by the user. If false, the XML element will be entirely removed from output XML when there's no string entered. |
placeholder | String | - | yes |
-
| Adds a placeholder to the text field to show the user what is expected on this field. If no placeholder is specified, the default will be the placeholder |
validations | String | - | yes |
| Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces. |
regex | boolean | - | yes | - | Indicates what regex is going to be used as a validation for this field. This attribute can only be used with the regex validation. |
min | integer | - | yes | - | Sets a minimum of characters allow. |
max | integer | - | yes | - | Sets a maximum of characters allow. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <password display="Password" type="password" placeholder="placeholder"> <dxf:help>Help for the password control.</dxf:help> </password> </properties> </dxf:template>
<properties> <password>encrypted:553775303A5877EF48C20463C01305E4</password> </properties>
A multi-line text entry control good for entering large blocks of text such as SQL statements, scripts, etc.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | String | - | yes | - | The default value to display if none is provided in the initialization data. |
placeholder | String | - | yes | - | Adds a placeholder to the text field to show the user what is expected on this field. If no placeholder is specified, the default will be the placeholder |
validations | String | - | yes |
| Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces. |
protocols | boolean | - | yes | - | Indicates which protocols can be used for this field. This attribute only can be used with the listurl validation. |
regex | boolean | - | yes | - | Indicates what regex is going to be used as a validation for this field. This attribute can only be used with the regex validation. |
min | integer | - | yes | - | Sets a minimum of characters allow. |
max | integer | - | yes | - | Sets a maximum of characters allow. |
trim | boolean | true | yes | - | If disable it will leave any white space at the beginning and the end of the value |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <textarea display="Textarea" type="textarea" rows="5" placeholder="placeholder" default="Default"> <dxf:help>Help for the textarea control.</dxf:help> </textarea> </properties> </dxf:template>
<properties> <textarea>Default</textarea> </properties>
A check box control for true/false boolean data.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | boolean | false | yes | - | Indicates if the checkbox will be checked |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <boolean display="Boolean" type="boolean" default="true"> <dxf:help>Help for the boolean control.</dxf:help> </boolean> </properties> </dxf:template>
<properties> <boolean>true</boolean> </properties>
A box with increasing and decreasing options for number ranges. If something that it is not a number is inserted in this control, it will return empty.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | integer | 0 | yes | - | The default value to display if none is provided in the initialization data. |
validations | String | - | yes |
| Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces. |
min | integer | - | yes | - | Sets a minimum number allow. If not set then there is no minimum |
max | integer | - | yes | - | Sets a maximum number allow. If not set then there is no maximum |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <integer type="integer" default="10" min="0" max="100" display="Integer"> <dxf:help>Help for the integer control.</dxf:help> </integer> </properties> </dxf:template>
<properties> <integer>10</integer> </properties>
A check box control for true/false boolean data.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The default label to display as the legend of the list. |
default | boolean | false | yes | - | The default value for all the checkboxes in the list. |
itemValues | String | - | no | - | The list of values that are going to be checkboxes separated by comma e.g. ("one,two,three,...") |
itemNames | String | - | yes | - | The list of names to display before each checkbox e.g. ("A,B,C,D,E,F,G,H,I,J") *The names must be in the same order as the values. |
itemTagName | String | - | np | - | The name of the tag for the checkboxes. |
validations | String | - | yes |
| Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <checklist type="checklist" itemValues="1,2,3,4,5,6" itemNames="One,Two,Three,Four,Five,Six" itemTagName="item" default="true" display="Check List"> <dxf:help>Help for the check list.</dxf:help> </checklist> </properties> </dxf:template>
<properties> <checklist> <item value="1">true</item> <item value="2">true</item> <item value="3">true</item> <item value="4">true</item> <item value="5">true</item> <item value="6">true</item> </checklist> </properties>
Allows the user to select a single item from a list of alternatives using a single selection pull-down control. Options in the pull-down can map what is displayed to the user to a different value stored in the output XML.
Attributes:
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | String | - | yes | - | The default value to display if none is provided in the initialization data. This must be one of the "values" specified on one of the nested <dxf:option> tags. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
The pulldown type must have nested <dxf:option> tags to specify the enumerated list of options which will be displayed to the user. Attributes for this tag include:
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | yes | - | The value to display to the user for the option. If display is missing, then value will be used for display. |
value | String | - | no | - | The value to be output in the result XML for the item. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <pulldown display="Pulldown" type="pulldown"> <dxf:help>Help for the pulldown control.</dxf:help> <dxf:option display="Option 1">Option A</dxf:option> <dxf:option display="Option 2">Option B</dxf:option> <dxf:option display="Option 3">Option C</dxf:option> </pulldown> </properties> </dxf:template>
<properties> <pulldown>Option A</pulldown> </properties>
<updateFrequency>WEEKLY</updateFrequency>
A pull-down control which is automatically filled out with the names of all installed applications that match a specified set of type flags. This is useful for creating routing tables or branching destinations for job
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
typeFlag | String | - | no | - | The type of application to display in the pull-down. Only applications with an application.xml which has the specified type flag will be displayed in the pull-down. See Application Type Flags for more details. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <application display="Application" type="application" typeFlag="scheduled"> <dxf:help>Help for the application control.</dxf:help> </application> </properties> </dxf:template>
<properties> <application>/File_System</application> </properties>
A pull-down control which is automatically filled out with the names of all installed components that match a specified set of flags. The list of components returned to the control is only guaranteed to be valid when the form is created.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
factory | String | - | no | - | The Aspire factory name of the components required. don't use if you are going to use factory |
service | String | - | no | - | The jave interface that the component has registered and implemented. |
subType | String | - | yes | - | The sub-type of the required components. Returns all components from the factory if not given. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <componentfactory type="component" factory="aspire-solr-publisher" subType="default" display="Component Factory"> <dxf:help>Help for the component control.</dxf:help> </componentfactory> </properties> </dxf:template>
<properties> <componentfactory>/Publish_To_Solr/Main/PostHTTP</componentfactory> </properties>
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <componentservice type="component" service="com.searchtechnologies.aspire.services.Stage" subType="default" display="Component Service"> <dxf:help>Help for the component control.</dxf:help> </componentservice> </properties> </dxf:template>
<properties> <componentservice>/Publish_to_ElasticSearch/Main/PostHTTP</componentservice> </properties>
A pull-down control which has four (4) options to do scheduling.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | String | - | yes | - | The default value to display if none is provided in the initialization data. |
defaultType | String | false | yes |
| Select the type of scheduler you want to show by default, if non is selected it uses the best one according to the default value. |
useNone | boolean | false | yes | - | Enables the use of the option None. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <scheduler type="scheduler" default="0 0 0 ? * *" display="Scheduler" useNone="true"> <dxf:help>Help for the scheduler control..</dxf:help> </scheduler> </properties> </dxf:template>
<properties> <scheduler scheduleType="periodically">0 0/10 0/5 * * ?</scheduler> </properties>
Displays a button that test the connection of the current connector.
This DXF must only be used at the end of DXF for connectors.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:testconnection /> </properties> </dxf:template>
<properties> </properties>
The alternatives control allows the user to make a choice, and then based on that choice to fill out a set of nested form items. There are currently three supported "alternative" methods.
Attributes for <dxf:alternatives>:
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | The label to be displayed for the user before the control. |
default | String | - | no | - | The default value to display if none is provided in the initialization data. |
subType | String | - | no |
| The type of alternatives to show |
key | String | - | no | - | The XML tag which will be output as the key value |
Attributes for <dxf:alternative>:
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
display | String | - | no | - | What label to display to the user for this alternative. |
value | String | - | no | - | The value for the resulting XML tag to be output if this alternative is selected. |
The basic structure of all alternatives is shown below:
<dxf:alternatives subType="TYPE" display="DISPLAY LABEL" key="KEY"> <dxf:alternative display="DISPLAY LABEL" value="VALUE"> ** nested controls for first alternative go here ** </dxf:alternative> <dxf:alternative ...> ** nested controls for second alternative go here ** </dxf:alternative> ** Any number of alternatives can go here . . . </dxf:alternatives>
The "pulldown" alternatives type presents a pulldown with all the options. Additional form entry controls will be revealed underneath the pulldown once an option is selected.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:alternatives subType="pulldown" display="Alternavite Pulldown" key="alternativePulldown" default="Option B"> <dxf:help>Help for the alternatives control.</dxf:help> <dxf:alternative value="Option A" display="Option 1"> <option1 display="Boolean 1" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option1> </dxf:alternative> <dxf:alternative value="Option B" display="Option 2"> <option2 display="Boolean 2" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option2> </dxf:alternative> <dxf:alternative value="Option C" display="Option 3"> <option3 display="Boolean 3" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option3> </dxf:alternative> </dxf:alternatives> </properties> </dxf:template>
<properties> <alternativePulldown>Option B</alternativePulldown> <option2>false</option2> </properties>
The "accordion" alternatives type presents a set of radio buttons, each one with a banner. Additional form entry controls will be revealed underneath the selected radio button.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:alternatives subType="accordion" display="Alternavite Accordion" key="alternativeAccordion" default="Option B"> <dxf:help>Help for the alternatives control.</dxf:help> <dxf:alternative value="Option A" display="Option 1"> <option1 display="Boolean 1" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option1> </dxf:alternative> <dxf:alternative value="Option B" display="Option 2"> <option2 display="Boolean 2" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option2> </dxf:alternative> <dxf:alternative value="Option C" display="Option 3"> <option3 display="Boolean 3" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </option3> </dxf:alternative> </dxf:alternatives> </properties> </dxf:template>
<properties> <alternativeAccordion>Option B</alternativeAccordion> <option2>false</option2> </properties>
The "checkbox" type shows a checkbox. Based on the state of the checkbox (true or false), a different set of nested controls will be displayed. In the example below, only the "true" condition displays nested form controls.
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <dxf:alternatives subType="checkbox" display="Alternavite Checkbox" key="alternativeCheckboxn" default="false"> <dxf:help>Help for the alternatives control.</dxf:help> <dxf:alternative value="false"> <option1 display="Boolean 1" type="boolean"> <dxf:help>Help for the Option 1.</dxf:help> </option1> </dxf:alternative> <dxf:alternative value="true"> <option2 display="Boolean 2" type="boolean"> <dxf:help>Help for the Option 2.</dxf:help> </option2> </dxf:alternative> </dxf:alternatives> </properties> </dxf:template>
<properties> <alternativePulldown>Option B</alternativePulldown> <option2>false</option2> </properties>
This control is used to wrap multiple entries which need to be replicated. For example, if the target XML looks like:
<properties> <user name="xxx" domain="xxx"> <type>Allow</type> <user/> <user name="xxx" domain="xxx"> <name/> <type>Deny</type> </user> . . . </properties>
The multi-valued entry control allows to configure a template for the 'user' element once, and automatically add new sets as necessary.
Attribute | Type | Default | Optional | Options | Description |
---|---|---|---|---|---|
multiple | boolean | false | no | - | when true, will enable replication of all entries contained in such parent. Notice that not all parents support the multiple attribute, in which cases, you should wrap everything inside a tag. |
minCount | integer | 0 | yes | - | Tells the minimum amount of times entries should appear replicated. If zero, none will show. |
maxCount | integer | 0 | yes | - | Tells the maximum amount of times entries should appear replicated. If zero, there will be no limit. |
escapeValue | boolean | false | yes | - | Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string. |
<dxf:template version="1.0" xmlns:dxf="http://www.searchtechnologies.com/DXF/2011"> <properties> <parents> <child multiple="true" minCount="1" maxCount="4"> <dxf:attribute name="option" display="Option" type="string" placeholder="placeholder"> <dxf:help>Help for the string control.</dxf:help> </dxf:attribute> <dxf:attribute name="check" display="Check" type="boolean"> <dxf:help>Help for the boolean control.</dxf:help> </dxf:attribute> <optionType type="pulldown" display="Type" default="A"> <dxf:help>Help for the pulldown control.</dxf:help> <dxf:option display="Type A">A</dxf:option> <dxf:option display="Type B">B</dxf:option> <dxf:option display="Type C">C</dxf:option> </optionType> </child> </parents> </properties> </dxf:template>
<properties> <parents> <child option="first" check="false"> <optionType>A</optionType> </child> <child option="second" check="true"> <optionType>B</optionType> </child> </parents> </properties>