Installation and License

In the followings there are step by step instructions to install Firefly/Weaveworld environment and to request license.

Steps are given for Microsoft™ Windows™ operation systems, but they can be easily translated to Unix® platforms. See also the notes about Unix and Ubuntu.

Prerequisites

  • The visual Trace of the Firefly/Weaveworld uses the HTML5/WebGL, so a Graphics card is needed. (My computer has an onboard Graphic card, that works well).
  • To use visual Trace on a mobile/tablet, you may have to install Firefox or Chrome.
  • Browser automation needs a fast CPU, at least an i3.

Java JDK Install

Firefox

The visual Trace & Presenter uses the HTML5/WebGL 3D (with the help of the three.js). Firefly's visual Trace is supported mainly on Firefox (and also on Chrome, but not tested fully).

  • Note that only the client uses the browser's HTML5/WebGL 3D view. Using only the server or command line mode it is not necessary
  • One can control the Firefly/WW even from a tablet/mobile (as a client) using an installed Firefox or Chrome

You can test if your browser supports HTML5 WebGL/3D.

Unfortunatelly, Firefox sets off some WebGL features, by default (images are dim), so they have to be switched on.

  • Type about:config in the Location Bar (address bar) and press Enter
  • Set the followings to true
    • webgl.force-enabled
    • webgl.msaa-force
    • layers.acceleration.force-enabled
    • On Windows (to enable Direct2D Content Acceleration)
      • gfx.direct2d.force-enabled
    • On Android (to enable StageFright software decoding)
      • stagefright.force-enabled

Firefly/Weaveworld Install

Download and unzip

  • Firstly, the Firefly/Weaveworld framework has to be downloaded to the target computer, from the following page:
    Download and EULA
  • Unzip the inner content into a folder, e.g., C:/
    • → The zip file contains an inner ww folder, so the C:/ww folder will be created

Starter scripts

  • Check and modify initial SETs of the _ww (_ww.bat) script file in the ww/!.java folder; e.g.,
  SET JAVA="FULL_PATH_OF_THE_JAVA.EXE_OF_THE_JDK"
  SET WW_ROOT=C:\ww  
  ...
  • On Unix, set the '+x':
    • chmod u+x ww/!.java/*.sh
  • Now Firefly/Weaveworld is ready to the first start.

Requesting license

Without a license file, Firefly starts in the Personal Edition operational mode.

License can be requested using the information printed out by the Firefly's start.

Applying a valid license file switches on the Professional Edition.

First (mandatory) update and Running demos

License file has to be put into the 'ww/!.java' folder.

The installation kit contains only the base Weaveworld/ONCE components and the Firefly extension.
:!: In order to make/run tests of Web applications (and, to enable internal builds), Firefly/Weaveworld needs additional libraries (such as Selenium WebDriver, SQLite, Maven, etc.), that are downloaded by the first update.

  • In the 'ww/!.java' folder, please, start the '_wwupdate.bat' starter script file, if the computer is connected to the Internet.
    • → '_wwupdate' downloads the necessary libraries and may updates the Firefly/Weaveworld components, too.
    • Next update run has to show that there is no newer version
  • After the update you can test the program using the '.js' and '.firefly.bpmn' files from the 'demo' folder, e.g.,
    • !.java/ww.bat demo/hello.js?name=John
    • !.java/wwserver.bat demo/search/search.firefly.bpmn;trace;run

If some problem occures during the update or if you need a prepackaged installation kit, please, feel free to contact us at license@weaveworld.org.

Installing Eclipse and BPMN2 Modeler

The Firefly/Weaveworld environment can seamlessly work together with the famous free Eclipse development platform.
Eclipse and the BPMN2 plugin can be used the work with bpmn diagrams and create diagram images (for the graphical trace).

Eclipse

The Eclipse development environment is easy to install just to download and unzip the file.

  • Download Eclipse IDE for Java EE Developers from
    https://www.eclipse.org/downloads/ and Unzip the file
  • You can create a shortcut of eclipse.exe to your Desktop; you may rename it as eclipse or eclipseBPMN
  • Start Eclipse using the shortcut
    • (You may consider to use the empty ww/!.java/app/eclipse_workspace folder.)

BPMN2 Modeler

Follow the steps below to install the free BPMN2 Modeler Eclipse plugin:

  • Choose the Help / Install New Software menu
  • Copy the BPMN2 Modeler eclipse update site link into the Work with field
  • Click Add
  • Type a name such as BPMN2 Modeler and Click OK.
  • Click Select All and Next (This step may run for a while to compute alternate solutions)
  • Click Next buttons and Accept License Agreements until it starts installation
  • Following the prompt's instruction, restart Eclipse
  • :!: It's highly important that
    using Window / Preferences
    at General / Workspace
    the Text file encoding has to be set to UTF-8
  • :!: It's highly important that
    using Window / Preferences
    at BPMN2 / Editor / Behavior
    the Maximum text field length has to be set to 0
    (otherwise scripts and documentations will be truncated)
    • You may consider to switch on
      the Show ID on BPMN2 elements checkbox
      in order to find errors easier.

Now you can open a .bpmn file just drag&drop it to the eclipseBPMN icon on your Desktop, or if the eclipse is already opened then drop it to window of the Eclipse. After modifications and Save (Ctrl-S) the bpmn can be started by the Firefly/Weaveworld.

Installing 'MaryTTS' TextToSpeech

Firefly/Weaveworld's Presenter can cooporate with a TextToSpeech system, that is currently set to 'MaryTTS' (see http://mary.dfki.de/)

You have only to

  • download MaryTTS from the http://mary.dfki.de/download/index.html
  • install the program (or simply extract the files)
    • During install you may want to get some additional voice files
    • Additional voice files can be simple put into the 'lib' folder
  • set the MARY_BASE environment variable to point to the main folder
  • Firefly/Weaveworld's Presenter uses only some jar files of the 'lib' subfolder
  • The ww/!.java/bin/!.system/org.weaveworld.Say folder has a !.properties setting
    • The LOCALs has to be an IETF BCP 47 language tag string.
    • The VOICEs' jar files has to be exist in the MARY_BASE/lib folder
    • Current voice pair settings are:
      • voice-dfki-prudence-hsmm-5.1 from here (under Creative Commons License Attribution-NoDerivs 3.0 Unported (CC BY-ND 3.0))
      • voice-cmu-rms-hsmm-5.1 from here (under Carnegie Mellon University 'Arctic' license)

Notes

'Nailing' the Java, Eclipse, etc. installation

You may consider to copy the needed applications to the “ww/!.java/app” folder. This way one single folder contains all the necessary files and programs. You can zip (without the license file) this folder for archive purposes. The zip can be used as a preinstalled kit: one can just unzip it to another computer of the same OS and use it with the computer's license file.

  • Java
    • (You may consider to copy or move the JDK's folder from C:\Program Files\Java to ww/!.java/app to 'nail' Java to the Firefly/Weaveworld environment (so it can be copied to another computers) - see 'Notes')
  • Eclipse
  • (You may consider to extract 'Eclipse' into the ww/!.java/app folder. This way you 'nail' your Eclipse installation to the Firefly/Weaveworld environment, so you can copy it to another computers.)
  • (If the JDK is 'nailed' to the Weaveworld/Firefly, you have to change the eclipse.ini file's -vmargs parameter and add -vm argument according to your Java installation, for example:
-vm
C:/ww/!.java/app/jdk1.8.0_74/bin/javaw.exe
-vmargs
-Dosgi.requiredJavaVersion=1.8

Additional settings on Windows

  • You may consider to create shortcut on your Desktop pointing to the ww/!.java/wwserver.bat starter script, so it could be started clicking to it right from your Desktop
  • You may consider to create file associations
    - for .bpmn files to ww/!.java/wwserver.bat, and
    - for .js files to ww/!.java/ww.bat
    so these files can be easily started by clicking to them
  • If you currently work with some .bpmn and .js programs, you may consider to create shortcuts for them to your Desktop, so they could be started clicking to them from your Desktop

Using SeleniumIDE

''Selenium'' is a browser automation framework, what can be used to develop automatic tests of Web Applications, or even to program some Web-based tasks.

The Firefly/Weaveworld testing environment controls browsers with the help of Selenium WebDriver libraries. Additionaly, Firefly has a high level 'wrapper', what simulates some typical human interaction and control, so it is much easier to develop tests of highly dynamic (AJAX-based) Web pages.

The famous SeleniumIDE works as a Firefox plugin and is able to record some control on web pages. Firefly does not need SeleniumIDE, however this IDE can be a great help.

  • Firstly, using SeleniumIDE, one can record some web page controls and later can translate them to JavaScript statements (it is quite easy).
  • Furthermore, Firefly/Weaveworld can invoke saved SeleniumIDE Test Scripts ('.firefly.htm' files), but can perform only a reduced set of Selenium commands.
  • One convenient feature is that SeleniumIDE can show several versions of XPath expressions or other 'selectors' of elements, what is essential on highly dynamic pages.
  • SeleniumIDE is mentioned on the Selenium's general download page.
  • Plugin versions can be found in a Web accessible folder.
    • From a Firefox Web browser clicking to the .xpi file, the plugin is to be installed.
    • After a browser restart the plugin is ready to be used.
    • Clicking the appeared 'Se' icon on the browser starts immediately the action-recording.

Java JDK on Ubuntu

On Ubuntu you may want to follow this guide. The steps are basically the next ones:

  • for Default JDK
    • sudo apt-get update; sudo apt-get install default-jdk
  • for OpenJDK
    • sudo apt-get update; sudo apt-get install openjdk-8-jdk
  • for Oracle JDK
         sudo apt-get update
         sudo apt-get install python-software-properties
         sudo add-apt-repository ppa:webupd8team/java
         sudo apt-get update
         sudo apt-get install oracle-java8-installer
  • Managing Java installations:
    • sudo update-alternatives --config java
  • Managing Java Compiler installations:
    • sudo update-alternatives --config javac

Starting Firefly/Weaveworld from Eclipse

Additionaly, the Firefly/Weaveworld starter scripts (ww.bat and wwserver.bat) can be set as Eclipse External Tool.

  • Choose the menu Run / External tools / External tool configurations
  • Click Program
  • Click the New launch configuration icon
  • On the Main tab
    • Set Name to ww (or wwserver))
    • Set Location to C:/ww/!.java/ww.bat (or …wwserver-start.bat)
    • Set Working Directory to C:\ww
    • Set Arguments to ${resource_loc}
  • On the Refresh tab
    • Set Refresh resources upon completion
      to the third The project containing… choice
  • On the Common tab
    • Set Encoding to UTF-8
  • Finally, Click Close

Now, having an opened .firefly.bpmn or .js file in Eclipse, you can start it directly by clicking the External Tools icon, selecting the ww or wwserver and click Run.
(Note that Firefly/Weaveworld as an Eclipse External Tool has less priority in scheduling, e.g., the graphical trace may produce lagging.)

Appendix: Folders

install/install_and_license.txt · Last modified: 2017/01/10 08:28 (external edit)
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0