XMEG System Documentation: Operation

[Back to contents]

This section explains the system requirements and directory structure of the XMEG system, as well providing installation instructions and post installation configuration instructions.

System Requirements

Requirement	Comment
Hardware	XMEG has no specific hardware requirements, however due to the nature of dealing with multimedia assets it is suggested that at least Pentium 500MHz and 64MB RAM systems are used.
Operating System	XMEG is written in Java and is therefore platform independent. Java implementations exist for all major operating systems.
Java Runtime Environment 1.4 or higher	The JRE comes with most standard Windows 2000/XP installations. Java is also standard on most Linux & Mac OS X operating systems. Otherwise it may be downloaded from Sun Microsystems.
Java Media Framework Version 2.1 (Optional)	This library allows XMEG to open audio and video files as well as providing support for the recording of audio annotations. XMEG can be run without the Java Media Framework if you will only be viewing text and image files. Otherwise you will have to download the JMF from Sun Microsystems JMF download page. Instructions for installing the JMF are provided later in this document.
Java 3D libraries (Optional)	To view 3D OBJ files in XMEG you will need to download and install Java 3D from the Java 3D downloads page. Instructions for installing the J3D are provided later in this document.

XMEG comes with the following third party software:

No installation is required for these libraries.

Directory Structure

COPYRIGHT.txt - Legal notices for IKM and third party libraries
CVS - CVS metadata
README.txt - XMEG readme file
config.xml - default configuration file
docs/ - XMEG documentation
license.txt - License key file for XMEG
lib/ - JAR libraries of XMEG, JMF & J3D
logs/ - log files
media/ - default location for media resources
metadata/ - default location for XML metadata resource files, some sample files
run-xmeg.bat - Windows run script
run-xmeg.sh - Bash run script (Unix, Linux, Mac OS X)
xml/ - Default location for schema definitions & user profile documents

schema.xml - default schema definition file
users.xml - default user profile file

As XMEG is Java based the program itself does not need installation. This section therefore describes how to activate the license key and setup the third party libraries used by XMEG: Java Media Framework and Java 3D.

Activating your license of XMEG

From the list of files and directories above you will see a license.txt listed. When you downloaded the XMEG software you should also have been sent a license.txt file. This is your unique license for the XMEG system. To activate it simply copy to the location shown above. It will be read and checked when the XMEG system is run.

Java Media Framework

If you would like audio and video support within XMEG you will have to download and install the Java Media Framework. The JMF can be downloaded at: http://java.sun.com/products/java-media/jmf/2.1.1/download.html. If you are installing JMF for Windows select the following options when running the Windows installer:

Installing JMF under Window

Installing JMF under Windows

Java 3D

If you would like support for 3D OBJ objects within XMEG you will have to download and install Java 3D. J3D can be downloaded at: http://www.j3d.org/download.html. Simply follow the default installation instructions provided.

Configuration

The config.xml file (See Directory Structure & Files) is provided to record configuration settings. The ConfigManager is a graphical tool that allows users to edit the configuration file from within the XMEG system. See the ConfigManager section of the User Manual. When you launch the XMEG application for the first time it will normally launch the ConfigManager:

Fig 1: ConfigManager

Fig 7: ConfigManager

The following elements must be set for your particular installation:

schema: path to the XML file that defines the rights data model, default schema may be used (See Directory Structure).
users: path to the XML file that contains user profiles.
metadata-dir: default location to save XML metadata files, normally the metadata directory.
media-dir: default location to look for media files.
*-extns: list of extensions for different media formats

The config.xml can also we edit by hand if needed using a text editor (such as Notepad). An example of config.xml is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <schema>C:\xmeg\xml\default_schema.xml</schema>
    <users>C:\xmeg\xml\users.xml</users>
    <metadata-dir>C:\xmeg\metadata</metadata-dir>
    <media-dir>C:\xmeg\media</media-dir>
    <text-extns>txt html tex</text-extns>
    <image-extns>jpg jpeg jpe png tiff tif gif bmp</image-extns>
    <audio-extns>mpg mpeg mp3 avi wav au</audio-extns>
    <video-extns>mpg mpeg</video-extns>
</config>

Example of config.xml configuration file

^^[Back to Top] | [Back to contents]