This examples shows the DXF template, how this template will be displayed in the user interface as an HTML form, and then the XML file which is produced after the user fills out the form and clicks "Save".
On this page:
Determine exactly why you need to use DXF. This will determine what file you will need to create or edit.
- I am Creating an Application Bundle
- If you want to specify properties to be edited by the administrator when your application is installed, you will need to edit the DXF Template stored in config/application-dxf.xml.
- I am Creating a Connector
- If you are creating a connector, you will likely need to create a DXF template stored in src/main/resources/dxf/contentSource.xml.
- This file will be used to specify the properties that are required for every content source which is submitted to your connector.
- I want to use DXF for something else
In the template, tags strictly for DXF purposes are prefixed with "dxf:". All other tags are copied to output when the form is submitted.
In the example below, all tags which start with <dxf:...> are special tags which control how the user interface is displayed. The tags <properties> and <managerExternalRDB> and similar are application-specific tags which are used to structure the metadata when the resulting XML data is produced.
Example DXF Template:
User Interface Form
When shown in a browser, the user interface for the dxf.xml template shown above will look like this:
Note that each ? icon is a tooltip help which will display the contents of the <dxf:help> tag for each input element (admittedly, the help expressed above is not wonderful, it is left as an exercise for the reader to come up with better help text).
Once the user has filled out the information in the form and has clicked on "Save", DXF will produce the following XML as output:
Then What Happens?
What happens next depends on the application. If installing a new application, the admin UI will take the XML and write it as properties along with the application to the admin RESTful interface. The properties are then stored in the settings.xml file as part of the application's auto-start properties.
If the DXF is used to configure a content source for a particular connector, the XML is written to a database BLOB. When the content source is then crawled, the XML will be provided to the connector so that it knows what to crawl and has all of the other information (user name, password, include patterns, exclude patterns, etc.) it needs to execute the crawl.
Finally, if the DXF is used to configure an individual Aspire component, then the resulting XML will be sent to the component's component factory, will will shut down the old version of the component and then restart the component with the new configuration.