Table Of Contents

• About XMLSpy Integration
• Content Files
• Technical Requirements
• Licensing / Processing Modes
  • Full Mode
  • Trial Mode
• Installation
• Running Ant Demo
• Running Maven Demo
• Getting Help

About XMLSpy Integration

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 the 'XMLSpyInterface.jar' Java library, which 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.

But having XMLSpy generate the diagrams is not enough. Further, the diagrams need to be inserted into the output generated with templates. Here is how it is done.

DocFlex/XML templates operate with abstract data entities called DSM elements (and DSM attributes), on which everything contained in XML files (as well as XML files themselves) is mapped. That mapping is maintained by a special module called XML DSM driver. Each DSM element may have a certain graphic representation called element image, which is provided by a special extension of the DSM driver called Element Image Provider. Element images can be easily operated in templates using Image Controls.

Once the diagrams have been generated by XMLSpy, the integration associates them (as well as imagemap hyperlinks) with the DSM elements representing corresponding XML schema components. Further, a special Element Image Provider implemented within the integration treats each diagram as an element image of the DSM element associated with the XML schema components depicted on that diagram. In that way, the diagrams become accessible via Image Controls in templates, which makes possible to easily program their insertion in the output generated by DocFlex/XML.

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 (or docflex-xml-re.jar). However, in order to use it, the integration needs to be installed separately and requires separate licensing.

Content Files

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

Technical Requirements

• Altova XMLSpy®, versions 2004-2009, "Professional" or "Enterprise" edition.

  Basically, what is needed for the integration to work is that your XMLSpy edition supports:

  1. XMLSpy Java interface (XMLSpyInterface.jar)
  2. "XML Schema documentation" feature

  (For instance, the "Standard" edition has no such things.)

• Java version 6 or 5.0 (JDK or JRE) installed on your system. (Java 6 is better as it works faster).
• A computer with at least 1 GB RAM (2 GB is better!)

Licensing / Processing Modes

Full Mode

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

• You may use the integration working in trial mode only during the limited period of time (30 days) provided by your Trial License.

• Any output documents generated in trial mode will contain special trial markers. Such documents may be used only for evaluation of this software. Any other usage is prohibited!

Installation

1. In 'JAVA_HOME' variable, specify the location of your Java 6 or Java 5 installation directory. For example:

   set JAVA_HOME="C:\Program Files\Java\jre6"

   Note: When the directory pathname contains spaces, it must be enclosed in double quotes!

2. In 'XMLSPY_JAVA_LIB' variable, specify the location of 'XMLSpyInterface.jar' file that must be found in your XMLSpy installation directory. For example:

   set XMLSPY_JAVA_LIB="C:\Program Files\Altova\XMLSpy2009\XMLSpyInterface.jar"

   Note: When the file pathname contains spaces, it must be enclosed in double quotes!

3. In 'XMLSPY_VERSION' variable, specify your XMLSpy version number. For example:

   set XMLSPY_VERSION=2009

   Note: The acceptable version number must be an integer in the range from 2004 to 2009

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

For further specific details about the installation of XMLSpy Integration, please see: www.filigris.com | DocFlex/XML | Integrations | XMLSpy | Installation

Running Ant Demo

1. Edit ant\build.xml to specify:
   • In 'XMLSPY_JAVA_LIB' property set the location of 'XMLSpyInterface.jar' file (found in your XMLSpy installation directory)
   • In 'XMLSPY_VERSION' property set your XMLSpy version

2. Edit ant\make.bat to specify the locations of your Java and Ant installations
3. Run ant\make.bat

Running Maven Demo

1. Install (or reinstall) DocFlex/XML Maven Plugin (so that it could call XMLSpy from itself) as follows.

   In {docflex-xml}\mavem\plugin\ directory, edit pom.xml to uncomment the following lines and specify the absolute location of XMLSpy Java interface library and XMLSpy version:

   <dependency>
     <groupId>xmlspy</groupId>
     <artifactId>XMLSpyInterface</artifactId>
     <version>2009</version>
     <scope>system</scope>
     <systemPath>C:\Program Files\Altova\XMLSpy2009\XMLSpyInterface.jar</systemPath>
   </dependency>
   

   Further, follow the installation instruction found in {docflex-xml}\mavem\plugin\index.html

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

   Edit pom.xml to specify your XMLSpy version in the following line:

   <param>-m:XMLSPY_VERSION=2009</param>

   Edit site.bat to specify the locations of your Java and Maven installations.

3. Run site.bat

Getting Help

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