Chapter 1 - Installing Agilian

Installing AG (Agilian) is an easy task. However, there do have things that you should be aware of. For example, about the relationship between Agilian and Visual Paradigm Suite, and how to import a valid license key. This chapter will show you how to get Agilian started from downloading to running the application. Here are the covered topics:

Downloading Visual Paradigm Suite

There is no separate installer made for AG. In order to install AG, you must download and install Visual Paradigm Suite, an application suite that includes all the Visual Paradigm products, and install AG from the suite. To download Visual Paradigm Suite:

  1. Visit Visual Paradigm's official download site at:
    http://www.visual-paradigm.com/download/
  2. Click on the image for Visual Paradigm Suite.
    Figure 1 - Click to visit the download page of Visual Paradigm Suite
  3. Enter your account information, and click Continue to proceed.
    Figure 2 - Login to proceed to download
  4. Under the list of Evaluation Product(s), select Agilian. This option will affect the capability of the evaluation key, which will be sent upon downloading the suite.
  5. Choose the way of receiving the evaluation key, or not to receive it. Here are the description of each of the possible ways:
    Ways of receiving an evaluation key Description
    Do not send me the evaluation key Just to download the suite without the need of an evaluation key.
    Send via email as attachment You will receive an email attached with the key file. Make sure your server allows email with attachments for choosing this option.
    Send via email as URL You will receive an email, which includes a download link of the key file.
  6. Select your operating system from the Platform drop-down menu.
  7. From the Mirror Site drop-down menu, choose the location that is closest to your current location for a faster download speed.
  8. Click Download to proceed with downloading the Visual Paradigm Suite.
    Figure 3 - Visual Paradigm Suite download page

Installing AG

The Visual Paradigm Suite installer provides a step-by-step graphical user interface for installing AG onto your system. Also, it lets you to create shortcuts under Start Menu for quick access to AG. Moreover, it helps registering Visual Paradigm project files with the operating system so that you can open the project file in AG simply by double-clicking on the file.

  1. Double-click on the installer file to launch the setup program.
    Figure 4 - Running the setup program
    Note
     For Linux platforms, execute the command bash ./%VP-SUITE-INSTALLER-FILENAME% (e.g. bash ./VP_Suite_Linux_3_0.sh)
  2. Click Next > to proceed to the License Agreement page.
  3. Read through the License Agreement carefully. Make sure you accept the terms before continuing with the installation. If you accept the agreement, select I accept the agreement and click Next > to proceed to the Select Destination Directory page.
    Figure 5 - Accepting the license agreement
  4. Specify the directory for installing Visual Paradigm Suite. Click Next > to proceed to the next page.
  5. Specify the name of the Start Menu folder that will be used to store the shortcuts. Keep Create shortcuts for all users checked if you want the shortcut to be available in all the user accounts in the machine. Click Next > to proceed.
    Note
     For Linux platforms, select a folder for creating symlinks. You may select Don't create symlinks if you do not want to.
    For Mac OS X platforms, select whether you want to create desktop icon(s) that act as shortcut(s) to the installed products.
  6. Keep Visual Paradigm Project (*.vpp) and Visual Paradigm License File (*.zvpl) checked if you want your system able to open the project file and the license key file. Click Next > to proceed to the product selection page.
  7. Select Agilian. Click Next > to proceed to the product configuration page.
    Figure 6 - Selecting AG for installation
  8. AG features vary by product edition. For more details on the features supported by different editions, click the hyperlink Edition Comparison which brings you to the web page of AG feature comparison for different editions.

    Select the product edition from the Edition drop down menu.

    Figure 7 - Selecting the product edition
  9. For users who are going to run AG with a floating license, selecting Create Shortcut for Product Selection will result in creating a shortcut under the Start Menu for starting the Product Selector, a utility that lets you realize the installed products with available keys in the floating license server.
    Figure 8 - Section for Product Selector
  10. Select Download Online Help if you want to be able to access the Help contents from within the tool.
    Figure 9 - Selecting the option for downloading online help
  11. Select Download PDF/HTML Version if you wish to read the documentation in this two types of formats.
  12. Press Next > to proceed to the license import page.
  13. A combined license key is a key file which allows unlocking multiple products. To import a combined license key, select Combined License Key and specify the file path of the key.

    A single license key is a key file which allows unlocking only one product. To import a single license key, select Single License Key and specify the file path of the key.

    The import of license key is optional at this point, because you can import it when you run AG. Click Next > to proceed with copying files.

    Note
     For evaluation, the key should be sent to your email box (unless you have chosen not to receive it before download). If you have not received the email with key yet, and if you have selected to receive the key as attachment, the email might be treated as spam by mistake. Click on Request Evaluation Key to ask for another one. This time, try not to select sending the key as attachment.
  14. Upon finishing, you can select whether to start AG or not. Keep Agilian 1.0 selected and click Next > will run AG right away. Click Next > to finish the installation.
    Figure 10 - Finishing the installation and start AG
  15. Click Finish to close the setup program.

Starting AG

  1. Start AG by accessing the shortcut under the Start Menu.
    Figure 11 - Attempting to start AG through the shortcut under the Start Menu
    Note
     For Linux and Mac OS X platforms, execute the file 'run_ag' inside %VP-SUITE-INSTALLATION-DIR%/launcher
  2. The Workspace Launcher appears. A workspace is a repository of the UML projects. Besides storing projects, it stores also the settings, user interface perspectives and other preferences defined for the working environment. Specify the workspace folder.

    If you do not want this dialog box to appear again, check Use this as the default and do not ask again. This will cause AG to open the specified workspace folder automatically the next time.

    If you already have an existing workspace, you can import the settings from there by clicking Import Workspace...

    Click OK to continue.

    Figure 12 - Workspace Launcher
  3. If you have imported a valid license key before, AG should be started now. If not, the License Key Manager appears. The License Key manager is a utility for importing a license key. To import a key:

     

    1. Select License Keys > Import... from the menu.
    2. Specify the file path of the key file.
    3. Press Import to import the key file.

    Click Close to close the License Key Manager and start AG. If it prompts you with an invalid license key message, make sure the key you imported does match with the tool that you are running in terms of the following aspects:

    Figure 13 - The License Key Manager

Uninstalling AG

Uninstalling AG will cause AG to be removed from Visual Paradigm Suite. To uninstall AG:

  1. Close AG if it is running.
  2. Run %VP-SUITE-INSTALLATION-DIR%/uninstaller/uninstall_vpuml.exe
    Note
     For Linux and Mac OS X platforms, execute the file 'uninstall_vpuml' inside %VP-SUITE-INSTALLATION-DIR%/uninstaller

Uninstalling Visual Paradigm Suite

Uninstalling Visual Paradigm Suite will cause the suite together with the products installed from the suite to be removed from the machine. To uninstall Visual Paradigm Suite:

  1. Close all the application installed from the suite.
  2. Run %VP-SUITE-INSTALLATION-DIR%/uninstall.exe
    Note
     For Linux and Mac OS X platforms, execute the file 'uninstall' inside %VP-SUITE-INSTALLATION-DIR%.