Page tree
Skip to end of metadata
Go to start of metadata

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.

On this page:

Help


Can only be use inside another dxf control. Display a question markright next to the control with helpful information.

Dxf Template

<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>

Display

Annotation


Displays a message in the configuration.

AttributeTypeDefaultOptionalOptionsDescription
subTypeStringinfo yes
  • tip
  • info
  • note
  • warning
Indicates the type of message to display

Dxf Template

<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>

Display

XML Output

<properties>
</properties>

Headers: <dxf:h1>, <dxf:h2>


These headers display header text in the form. They are for display only, they have no affect on the XML output.

Dxf Template

<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>

Display

XML Output

<properties>
</properties>

Horizontal Rule: <dxf:hr>


Displays a horizontal rule in the form. This is for display only, it has no affect on the XML output.

Dxf Template

<dxf:template version="1.0"  xmlns:dxf="http://www.searchtechnologies.com/DXF/2011">
   <properties>
     	<dxf:hr/>
   </properties>
</dxf:template>

Display

XML Output

<properties>
</properties>

Line Break <dxf:br>


Copies an HTML <br/> tag to the output. This may be useful for adding space after other UI widgets.

Dxf Template

<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>

Display

XML Output

<properties>
</properties>

Fieldset: <dxf:fieldset>


Groups a set of components in a same category

 

AttributeTypeDefaultOptionalOptionsDescription
legendStringinfoyes

-

Indicates the type of message to display
collapsebooleanfalseyes-Enables the option to collapse the fieldset
isCollapsedbooleanfalseyes-Indicates if the fieldset will be collapse on display

Dxf Template

<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>

Display

XML Output

<properties>
</properties>

Constant


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.

Dxf Temp

AttributeTypeDefaultOptionalOptionsDescription
visiblebooleanfalseyes

-

 Indicates is the constant will appear in the configuration,
displayString-yes-The label to be displayed for the user before the control, if the constant is visible.
helpString-yes-Adds a tooltip, if the constant is visible.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<properties>
	<constant>ABCD</constant>
</properties>

String


A simple text-entry box.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultString-yes-The default value to display if none is provided in the initialization data.
allowEmptyStringbooleanfalseyes-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.
placeholderString-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
validationsString-yes
  • required
  • url
  • integer / int
  • double / float
  • cron
  • maven
  • regex / pattern
  • path
  • timeperiod / time
  • invalidchars
Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces.
protocolsString-yes-Indicates which protocols can be used for this field. This attribute only can be used with the url validation.
regexString-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.
mininteger-yes-Sets a minimum of characters allow.
maxinteger-yes-Sets a maximum of characters allow.
trimbooleantrueyes-If disable it will leave any white space at the beginning and the end of the value
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

 

Dxf Template

<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>

Display

XML Output

<properties>
	<string>Default</string>
</properties>

Password


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.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
allowEmptyStringbooleanfalseyes-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.
placeholderString-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
validationsString-yes
  •  required
  • regex / pattern
Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces.
regexboolean-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.
mininteger-yes-Sets a minimum of characters allow.
maxinteger-yes-Sets a maximum of characters allow.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

 

Dxf Template

<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>

Display

XML Output

<properties>
	<password>encrypted:553775303A5877EF48C20463C01305E4</password>
</properties>

Textarea


A multi-line text entry control good for entering large blocks of text such as SQL statements, scripts, etc.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultString-yes-The default value to display if none is provided in the initialization data.
placeholderString-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
validationsString-yes
  • required
  • listurl
  • regex / pattern
Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces.
protocolsboolean-yes-Indicates which protocols can be used for this field. This attribute only can be used with the listurl validation.
regexboolean-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.
mininteger-yes-Sets a minimum of characters allow.
maxinteger-yes-Sets a maximum of characters allow.
trimbooleantrueyes-If disable it will leave any white space at the beginning and the end of the value
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

 

Dxf Template

<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>

Display

XML Output

<properties>
	<textarea>Default</textarea>
</properties>

Boolean


A check box control for true/false boolean data.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultbooleanfalseyes-Indicates if the checkbox will be checked
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<properties>
	<boolean>true</boolean>
</properties>

Integer


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.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultinteger0yes-The default value to display if none is provided in the initialization data.
validationsString-yes
  • required
Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces.
mininteger-yes-Sets a minimum number allow. If not set then there is no minimum
maxinteger-yes-Sets a maximum number allow. If not set then there is no maximum 
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<properties>
	<integer>10</integer>
</properties>

Check List


A check box control for true/false boolean data.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The default label to display as the legend of the list.
defaultbooleanfalseyes-The default value for all the checkboxes in the list.
itemValuesString-no

-

The list of values that are going to be checkboxes separated by comma e.g. ("one,two,three,...")
itemNamesString-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.
itemTagNameString-np-The name of the tag for the checkboxes.
validationsString-yes
  • required
Indicates which validations are going to be applied to this field. All the validations must be separated by a comma (,) without spaces.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<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>

Pulldown


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:

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultString-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.
escapeValuebooleanfalseyes-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:

AttributeTypeDefaultOptionalOptionsDescription
displayString-yes

-

The value to display to the user for the option. If display is missing, then value will be used for display.
valueString-no-The value to be output in the result XML for the item.

 

Dxf Template

<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>

Display

XML Output

<properties>
	<pulldown>Option A</pulldown>
</properties>
 <updateFrequency>WEEKLY</updateFrequency>

Application


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

 

 

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
typeFlagString-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.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<properties>
	<application>/File_System</application>
</properties>

Component


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.

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
factoryString-no-The Aspire factory name of the components required. don't use if you are going to use factory
serviceString-no-The jave interface that the component has registered and implemented.
subTypeString-yes

-

The sub-type of the required components. Returns all components from the factory if not given.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template Factory

<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>

Display

XML Output

<properties>
	<componentfactory>/Publish_To_Solr/Main/PostHTTP</componentfactory>
</properties>

Dxf Template Service

<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>

Display

XML Output

<properties>
	<componentservice>/Publish_to_ElasticSearch/Main/PostHTTP</componentservice>
</properties>

Scheduler


A pull-down control which has four (4) options to do scheduling.

 

 

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultString-yes-The default value to display if none is provided in the initialization data.
defaultTypeStringfalseyes
  • periodically
  • daily
  • weekly
  • advanced
  • none
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.
useNonebooleanfalseyes

-

 Enables the use of the option None.

 

Dxf Template

<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>

Display

XML Output

<properties>
	<scheduler scheduleType="periodically">0 0/10 0/5 * * ?</scheduler>
</properties>

Test Connection


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

<dxf:template version="1.0"  xmlns:dxf="http://www.searchtechnologies.com/DXF/2011">
   <properties>
	 <dxf:testconnection />
   </properties>
</dxf:template>

Display

XML Output

<properties>
</properties>

Alternatives & Alternative


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>:

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

The label to be displayed for the user before the control.
defaultString-no-The default value to display if none is provided in the initialization data.
subTypeString-no
  • pulldown
  • accordion
  • boolean
The type of alternatives to show
keyString-no

-

The XML tag which will be output as the key value

 

Attributes for <dxf:alternative>:

AttributeTypeDefaultOptionalOptionsDescription
displayString-no

-

What label to display to the user for this alternative.
valueString-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>

Alternatives: Pulldown

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

<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>

Display

XML Output

<properties>
	<alternativePulldown>Option B</alternativePulldown>
    <option2>false</option2>
</properties>

Alternatives: accordion

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

<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>

 Display

XML Output

<properties>
	<alternativeAccordion>Option B</alternativeAccordion>
    <option2>false</option2>
</properties>

Alternatives: checkbox

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

<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>

Display

XML Output

<properties>
	<alternativePulldown>Option B</alternativePulldown>
    <option2>false</option2>
</properties>

Parent (Multi-Valued Entry Control)


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.

AttributeTypeDefaultOptionalOptionsDescription
multiplebooleanfalseno

-

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.
minCountinteger0yes-Tells the minimum amount of times entries should appear replicated. If zero, none will show.
maxCountinteger0yes-Tells the maximum amount of times entries should appear replicated. If zero, there will be no limit.
escapeValuebooleanfalseyes-Inserts all the children and values into a <![CDATA[ ]]> to return the value as a string.

Dxf Template

<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>

Display

XML Output

<properties>
    <parents>
        <child option="first" check="false">
            <optionType>A</optionType>
        </child>
        <child option="second" check="true">
            <optionType>B</optionType>
        </child>
    </parents>
</properties>