DocFlex/XML XMLSpy Integration, Version 1.5


Table Of Contents


About XMLSpy Integration

The integration of DocFlex/XML with Altova XMLSpy® is a special add-on to the DocFlex/XML core that allows users to automatically insert the graphics diagrams produced by XMLSpy into the XML schema documentation generated by DocFlex/XML XSDDoc (with full support of diagram hyperlinks).

This is not an XMLSpy plugin. (That would be actually impossible because XMLSpy itself is not based on Java.) Rather, the integration allows DocFlex/XML to launch an instance of XMLSpy as a separate parallel process and call some its functionality, essentially turning XMLSpy into a DLL (Dynamically Linked Library). Such usage in fact was supported by Altova itself, who includes in XMLSpy a Java API that provides all necessary interfaces.

The integration exposes that functionality to templates via several FlexQuery functions, which allow a template to:

  1. Launch XMLSpy (start a session to communicate with it).
  2. Process with XMLSpy a specified XSD file. That is force XMLSpy to open that schema and generate diagrams (along with imagemaps) for its components to be further processed by the integration.
  3. Shut down the XMLSpy.
You can find all those functions via Template Designer main menu: Help | Assistant | Functions | By Category | XMLSpy Integration Functions.

Since XMLSpy Integration is heavily connected with the DocFlex/XML core, all Java classes implementing it are currently included in the general DocFlex/XML Java library: docflex-xml.jar. However, in order to use it, the integration requires the separate setup and license.

For all details about the XMLSpy Integration, please see: www.filigris.com | DocFlex/XML | Integrations | XMLSpy.

Content Files

README.html this file
*.bat Windows command files to run DocFlex/XML integrated with XMLSpy:
generator.bat
  • Starts the generator from command line
designer.bat
  • Launches the Template Designer (all XMLSpy-related functions will be active and you can invoke the generator integrated with XMLSpy)
linux/ Linux shell script files to run DocFlex/XML+XMLSpy on Linux:
linux/generator.sh
  • Starts the generator
linux/designer.sh
  • Launches the Template Designer
linux/xmlspy.sh
ant/ Ant example files:
ant/build.xml
  • The Ant build file that demonstrates how to call the unified DocFlex/XML+XMLSpy documentation generator from the Apache Ant so as to generate an XML Schema documentation with diagrams.
ant/make.bat
maven/ A demo project that shows how to configure the unified DocFlex/XML+XMLSpy Maven plugin to generate an XML Schema documentation with diagrams for the reports section of a Maven-generated site:
maven/pom.xml
  • The project POM file
maven/site.bat

Note: These files and directories can be found in 'integrations/XMLSpy/' subdirectory of each edition of DocFlex/XML.

Technical Requirements

Licensing / Processing Modes

Being a complex piece of software that took great efforts to develop, the XMLSpy Integration requires a separate licensing. Depending on your license, the integration may work in one of two different modes: full or trial.

Full Mode

The Full Mode is activated in the presence of a Commercial or Academic License for "DocFlex/XML XMLSpy Integration".

This mode allows you to use the integration without any limitations. Once it is enabled, you may think about the integration as yet another part of DocFlex/XML executables.

Anything else will depend on other your licenses.

Trial Mode

The Trial Mode is activated in the presence of a Trial License for "DocFlex/XML XMLSpy Integration". In this mode, the integration will work the same as in the full mode. However, no matter what your other licenses are, the following limitations will be enforced: The trial mode for XMLSpy Integration will not affect your possibility to create/modify templates. This is controlled by your license for DocFlex/XML SDK!

Installation (Windows)

Edit generator.bat and designer.bat as the following:
  1. In 'JAVA_HOME' variable, specify the location of your Java 7, Java 6 or Java 5 installation directory, e.g.:
    set JAVA_HOME=C:\Program Files\Java\jre7
  2. In 'XMLSPY_HOME' variable, specify the location of XMLSpy installation directory, e.g.:
    set XMLSPY_HOME=C:\Program Files\Altova\XMLSpy2013
  3. In 'XMLSPY_VERSION' variable, specify your XMLSpy version number, e.g.:
    set XMLSPY_VERSION=2013
  4. Copy the XMLSpy Integration license file 'docflex-xml-xmlspy.license', which you receive by e-mail, to the {docflex-xml}\lib directory (near the docflex-xml.jar file).

    Note: The license for XMLSpy Integration may be also included in a combined 'docflex-xml.license' file (along with other licenses), which should be also installed in the same location.

Now, everything must be ready. You can start generator.bat to run DocFlex/XML generator integrated with XMLSpy.

For further specific details about setting up XMLSpy Integration, please see: www.filigris.com | DocFlex/XML | Integrations | XMLSpy | Getting It Work

Installation (Linux)

  1. Install Wine. (How to install Wine on a particular Linux distribution you can find here: http://www.winehq.org/download/).

  2. Install XMLSpy on Wine. Use a command like this:
    wine XMLSpyEnt2013.exe
    (or simply click on the XMLSpyEnt2013.exe in a Linux file manager GUI).

    When the standard XMLSpy installation dialog appears, pass all its steps (the same as on Windows).

    After that, you will need to run XMLSpy so as to register your license for it. Typically the installer already creates (via Wine) a link on the desktop to run XMLSpy. If you don't see such a link, you can run XMLSpy directly. Open a terminal and type like this:

    wine 'C:\Program Files\Altova\XMLSpy2013\XMLSpy.exe'
    XMLSpy will be launched!

  3. Install Java for Windows on Wine. Use a command like this:
    wine jdk-7u4-windows-i586.exe
    (or just click on the 'jdk-7u4-windows-i586.exe' in a Linux file manager). When Java installation dialog appears, pass all its steps.

  4. Edit {docflex-xml}/integrations/XMLSpy/linux/generator.sh (and designer.sh) to specify the location and version of XMLSpy in the following lines:
    XMLSPY_HOME='C:\Program Files\Altova\XMLSpy2013'
    XMLSPY_VERSION='2013'
  5. Copy the XMLSpy Integration license file 'docflex-xml-xmlspy.license', which you receive by e-mail, to the {docflex-xml}/lib directory (near the docflex-xml.jar file).

    Note: The license for XMLSpy Integration may be also included in a combined 'docflex-xml.license' file (along with other licenses), which should be also installed in the same location.

Now, you can start linux/generator.sh to run DocFlex/XML generator integrated with XMLSpy (or linux/designer.sh to run the Template Designer).

Important:

Running Ant Demo

  1. Edit {docflex-xml}\integrations\XMLSpy\ant\build.xml to specify:

  2. Edit make.bat (in the same directory) to specify the locations of your Java and Ant installations
  3. Run make.bat
For more details about running DocFlex/XML+XMLSpy with Apache Ant, please see: www.filigris.com | DocFlex/XML | Integrations | XMLSpy | Running with Apache Ant

Running Maven Demo

  1. Install DocFlex/XML Maven Plugin.

    Follow the installation instruction found in {docflex-xml}\integrations\maven\plugin\index.html

  2. In {docflex-xml}\integrations\XMLSpy\maven\ directory:

    Edit pom.xml to specify the absolute pathname of your XMLSpy installation directory and XMLSpy version in the following line:

    <!-- XMLSpy home directory -->
    <XMLSPY_HOME>C:\Program Files\Altova\XMLSpy2013</XMLSPY_HOME>

    <!-- XMLSpy version -->
    <XMLSPY_VERSION>2013</XMLSPY_VERSION>
    Edit site.bat to specify the locations of your Java and Maven installations.

  3. Run site.bat
For more details about running DocFlex/XML+XMLSpy with Apache Maven, please see: www.filigris.com | DocFlex/XML | Integrations | XMLSpy | Running with Apache Maven

Getting Help

The most detailed and up-to-date information about the XMLSpy Integration can be found on this page: www.filigris.com | DocFlex/XML | Integrations | XMLSpy.

If you have any questions, suggestions, etc., please let us know by sending an email to: support@docflex.com or contact@filigris.com

Change Log

Version 1.5


Copyright© 2009-2013 Filigris Works, Leonid Rudy Softwareprodukte.
To contact us, please visit www.filigris.com or e-mail to: contact@filigris.com