Document type definition
The IdentityIQ DTD, or Document Type Definition, is a set of markup declarations of the XML objects used in IdentityIQ. It is most suitable for machine processing. For example, the DTD could be set up to help validate XML documents, or help composing XML documents in a integrated development environment.
In order to read the DTD file, first generate a document version using the console tool. The console tool is in the WEB-INF/bin folder under the web application.
Start the console application from a command line. In Windows:
C:> iiq.bat console
In Unix-like systems:
$ ./iiq console
At the console prompt enter the “dtd” command and specify a filename to store the DTD document:
> dtd
dtd <filename>
> dtd /tmp/identityiq.dtd
dtd written to "/tmp/identityiq.dtd"
The DTD file can now be found in /tmp.
Making the DTD “human readable”
The default version of the DTD is not set up to be read by a business user. The “dtddoc” tool exists to generate a set of web pages, similar to JavaDoc, which are more readily accessible to the average reader. The tool's website can be found at http://dtddoc.sourceforge.net/. The latest release is available from http://sourceforge.net/projects/dtddoc/. The tool requires Apache Ant1 to run.
Unpack the archive file in a suitable folder. Put the generated DTD file in that folder and run the following command:
ant -f buildant.xml
The tool will parse all available DTD files in the folder and generate a new folder call “doc”, with HTML, JavaScript and CSS styles, including an index file named doc/index.html. This file displays the DTD information in a more readable format and can be opened in a web browser.
DTD Doc output sample
Files
A few pre-generated sets of DTD information are linked below:
- IdentityIQ 8.0 Document Type Definition
- IdentityIQ 8.1 Document Type Definition
- IdentityIQ 8.2 Document Type Definition
- IdentityIQ 8.3 Document Type Definition
