You are here: UCM Web>UCMNavInstallation (21 Feb 2006)

UCMNav Installation

This page explains step by step what needs to be done in order to install

  • Use Case Maps Navigator (UCMNav) on different platforms
  • DOORS library for importing UCM models (optional)

UCMNav 2.x for Windows

UCMNav requires an X-server and Ghostscript to be installed. If you already have an X-server installed, skip the first four steps and go straight to step #5. We will be using Cygwin/X as the X-server here, but others (commercial and free, including Xming) are also available.

  1. Download the setup program from the Cygwin/X Project Home, and save it into a directory (e.g. download\cygwin).
  2. Execute the setup program, and select the following options:
    1. Install from Internet
    2. Into directory cygwin or Programs\cygwin for all users and Unix/binary text file type (note that for Cygwin, it is better to not have spaces in names for directories)
    3. Use the same directory for local packages as you did for the setup file (e.g. download\cygwin)
    4. Select the Internet Connection applicable to you
    5. Choosing a download site is a bit hit and miss. Some are slow, some are fast depending on the time of the day. Usually, is a good choice.
  3. Keep all packages selected by default and add the following (other dependent packages will be selected automatically by the setup program). Some servers will time-out if you are not quick enough with your selection of packages, but you may select and install these packages in several steps if you want.
    1. in category X11: X-start-menu-icons, X-startup-scripts, Xaw3d, Xorg-x11-devel, xorg-x11-f100, xwinwm
    2. in category Math: bc
    3. in category Publishing: psutils
  4. Hit next to start the download and installation - this will take some time.
  5. Execute the setup file for UCMNav 2.3 (in case you want more information see the UCMNav Tool Features Page). Install UCMNav in the default directory Program Files\UCMNav. Before finishing the installation, you may have to:
    1. Provide (in a DOS window) the IP address for the DISPLAY variable required by your X-server. It is unlikely that you will have to change the default value.
    2. Provide the name of the X-server executable program (with complete path), if the autodetection is not successful (the wizard currently looks for XFree86, XWin32, and eXceed in common default directories).
  6. The Startup Menu will include icons for UCMNav, documentation (in PDF), and uninstall.
  7. Since the installation may not find the X-server, we have to make sure that ucmnav.bat is set up correctly. In most cases, this means making sure that the bold parts of line 2, 3, 5, and 6 are correct. Only if you have installed an X-server other than Cygwin/X, will you also have to replace the Cygwin directories with the directories of your X-server in line 2 and 6.

1   @ECHO Starting UCMNav...
2   set PATH=%PATH%;C:\programs\cygwin\usr\X11R6\bin;C:\programs\cygwin\bin
3   set UCMNAV_HOME=/cygdrive/c/PROGRA~1/UCMNav
4   set DISPLAY=
5   cd "C:\PROGRA~1\UCMNav"
6   start /MIN C:\programs\cygwin\usr\X11R6\bin\XWin.exe -multiwindow
7   start /MIN UCMNav.exe
  1. Step 7 applies only if Cygwin is installed on your system. The setup program for UCMNav installs all its required libraries (*.dll) in the UCMNav directory. These libraries are Cygwin libraries. Since these libraries may conflict with the ones installed in steps 1 to 4, we have to move the dlls in UCMNav to the directory UCMNav\not used.

    The remaining steps are only required for the DOORS export

  2. The last step is to install the EPStoBMP tool which converts EPS files generated by UCMNav to BMP files for DOORS. Only if you do not have Cygwin installed on your system, extract the zip file for the full version of EPStoBMP to the UCMNav directory. If you have Cygwin installed, extract only the zip file for EPStoBMP to the UCMNav directory. Make sure that the directory UCMNav\EPStoBMP has been created.
  3. The EPStoBMP tool requires Ghostscript. If you do not have Ghostscript installed, execute the setup file for Ghostscript (in case you want more information see the Ghostscript, Ghostview and GSview Project Page).
  4. Once again, we have to make sure that ucm2bmp.bash is set up correctly (note that the first line tells the bash script where bash can be found).

If Cygwin was installed, ucm2bmp.bash will have to look something like this:
1   #! /cygdrive/c/Programs/cygwin/bin/bash
2   PATH=$PATH:'/cygdrive/c/Program Files/UCMNav':'/cygdrive/c/Programs/cygwin/bin'
3   ...
If Cygwin is not installed, ucm2bmp.bash will have to look something like this:
1   #! /cygdrive/c/progra~1/UCMNav/bash
2   PATH=$PATH:'/cygdrive/c/Program Files/UCMNav'
3   ...

  1. And one more time, we have to make sure that ps2bmp.bash is set up correctly.

If Cygwin was installed, ps2bmp.bash will have to look something like this:
1   #! /cygdrive/c/Programs/cygwin/bin/bash
2   ...
40   WORKING_DIR="c:/progra~1/UCMNav/EPStoBMP";
41   GSWIN_DIR="c:/progra~1/gs/gs8.51/bin";
42   ...
If Cygwin is not installed, ps2bmp.bash will have to look something like this:
1   #! /cygdrive/c/progra~1/UCMNav/bash
2   ...
40   WORKING_DIR="c:/progra~1/UCMNav/EPStoBMP";
41   GSWIN_DIR="c:/progra~1/gs/gs8.51/bin";
42   ...

  1. Finally, add a shortcut for EPStoBMP (e.g. Target: C:\Programs\cygwin\bin\bash.exe "c:\progra~1\UCMNav\ucm2bmp.bash", Start in: C:\Program Files\UCMNav) to your start menu.

Import tools for Telelogic DOORS 8.0

  1. UCMtoDOORS tool imports UCMs into DOORS. Extract the zip file for UCMtoDOORS 1.0.1 to the Program Files\Telelogic\DOORS_8.0\lib\dxl\addins directory (the exact location of this directory depends on where DOORS was installed).

UCMNav 2.x for Linux and Solaris

  1. Unzip and untar the distribution file in the desired target directory (on your binary path)
  2. UCMNav requires that the files included in the distribution ( for postscript output, and ucmnav-help.txt for on-line help ) be placed in a location pointed to by the environment variable UCMNAV_HOME. To set environment variables:
    • For csh
      • In your ~/.cshrc file, add: setenv UCMNAV_HOME ucmnav_directory
    • For tcsh
      • In your ~/.tcshrc file, add: setenv UCMNAV_HOME ucmnav_directory
    • For Bourne or bash shells
      • In your ~/.bashrc or ~/.profile, add: export UCMNAV_HOME=ucmnav_directory

UCMNav 2.x for Mac OS X

Mac OS X is a Unix-based system, and comes with an X11 server installed. Therefore, getting UCMNav to compile is fairly straightforward. However, there are some potential roadblocks that this document tries to address.

  1. UCMNav requires the xforms library. To install xforms and the set of libraries it depends on, use:
    • fink install xforms
    • For this to work you need to have the Fink package management tool installed. See the quick start instructions on the Fink project site for instructions on installing Fink.
  2. Download the UCMNav Source Code in the desired target directory, eg /usr/share/ucmnav.
  3. Make the following changes to the makeflags file:
    • CFLAGS = $(RPM_OPT_FLAGS) -DLQN -D_POSIX_SOURCE -D__DARWIN__ -I/usr/X11R6/include -I/sw/include/X11
    • LIBS   = -L$(LIBDIR) -L$(XLIBDIR) -L/sw/lib -lforms -lexpat -lX11 -lm
  4. Add the following lines at the beginning of the file:
    • #ifdef __DARWIN__
    • #undef _POSIX_SOURCE
    • #endif
  5. Run make to create the UCMNav executable
  6. Add the installation directory to your path, and set the UCMNAV_HOME variable. For tcsh, add:
    • set UCMNAV_HOME=/usr/share/ucmnav
    • set path=($path $UCMNAV_HOME)
  7. Start the X11 server. You can find it in /Applications/Utilities/X11
  8. In an xterm you can then enter: ucmnav
  9. Alternatively, you could combine the last two steps into: open-x11 ucmnav

These instructions for Mac OS X were created on Aug 17, 2004 by Michael Weiss (Carleton University).

-- Daniel Amyot - 26 Jan 2006

Topic revision: r2 - 21 Feb 2006 - 01:25:29 - Daniel Amyot
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback