Difference between revisions of "OS.bee Software Factory Installation Luna"

From OS.bee documentation
Jump to: navigation, search
(→‎before you start)
m (Mollik moved page OS.bee Software Factory Installation to OS.bee Software Factory Installation Luna without leaving a redirect: we have 2 installations now)
 
(86 intermediate revisions by 4 users not shown)
Line 5: Line 5:
 
=== License information ===
 
=== License information ===
  
−
The OS.bee Software Factory is distributed under a '''commercial license'''.
+
{{License information}}
−
 
+
−
The product itself is based on the OSBP Software Factory which is an [https://projects.eclipse.org/projects/technology.osbp "Eclipse Project"].
+
−
In addition, there are many other open source projects combined and the whole bunch of license used is listed [http://download.osbee.org/downloads/licenses/osbee-master-clean/osbp-used-lics.html "here"].
+
−
 
+
−
=== Java Version ===
+
−
 
+
−
To be able to use the OS.bee Software Factory you need to install the right Java version.
+
−
 
+
−
On Windows, this is '''Java JDK 8 64bit''' [http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html#javasejdk Java SE Downloads].
+
−
 
+
−
=== Eclipse Version ===
+
−
 
+
−
To be able to use the OS.bee Software Factory you need to start with the right Eclipse version.
+
−
You can use this one [http://download.osbee.org/downloads/eclipse-dsl-luna-SR2-win32-x86_64.zip Eclipse Luna DSL Developers SR2].
+
−
Download and extract it to a place you like.
+
  
 
== Installation of the Software Factory ==
 
== Installation of the Software Factory ==
  
−
=== Install the OS.bee Software Factory ===
+
=== Before you start ===
  
−
==== before you start ====
+
==== Java Version ====
  
−
To force the use of the required Java 8 mentioned above the default required java version property has to be changed from 1.6 to 1.8:
+
To be able to use the OS.bee Software Factory, you need to have the right Java version installed.
  
−
-Dosgi.requiredJavaVersion=1.8
+
On Windows, this is '''Java JDK 8 64bit''' [http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html#javasejdk Java SE Downloads].  If you have Java installed, there is generally a Java icon on the control panel which will enable you to find out the current version.
  
−
The following change in the <code>eclipse.ini</code> might help to avoid timeout problems with servers that respond slowly.
+
==== Eclipse Version ====
  
−
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000
+
To be able to use the OS.bee Software Factory, you need to have the correct Eclipse version installed.
−
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000
+
You can use [https://eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/lunasr2 Eclipse Luna DSL Developers SR2].
 +
Download and extract it to a folder location of your choosing. On Windows, we recommend '''C:\'''. This results in the installation folder '''C:\eclipse'''. This will be the assumed Eclipse installation folder for the rest of this document.
  
−
And it will help to give the Eclipse a little more memory:
+
To be able to launch Eclipse easily, create a shortcut to the program '''C:\eclipse\eclipse.exe''' on the computer's desktop . Be sure to add the parameter <code>-data /path/to/your/workspace</code> to the shortcut's invocation of Eclipse in order to start in the correct workspace in the future.  Otherwise, you will be prompted to specify a workspace each time you start Eclipse. <br>
−
 
+
−
-Xmx4096m
+
  
 +
Make the following additions / changes to the '''eclipse.ini''' file found in the '''C:\eclipse''' folder:
 +
<blockquote>
 +
-Dosgi.requiredJavaVersion=1.8<br>
 +
-Xmx4096m<br>
 +
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000<br>
 +
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000<br>
 +
</blockquote>
  
−
A resulting <code>eclipse.ini</code> for a Windows installation might look like:
+
The first line ensures that the required Java version is used. The second allocates extra memory for Eclipse to use and the last two help to avoid timeout problems with servers that respond slowly.
  
−
  -startup
+
A resulting '''eclipse.ini''' file for a Windows installation might look like this:<br>
−
plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
+
  -startup plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
 
  --launcher.library
 
  --launcher.library
 
  plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20150204-1316
 
  plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20150204-1316
−
  -product
+
  -product org.eclipse.epp.package.dsl.product
−
org.eclipse.epp.package.dsl.product
+
 
  --launcher.defaultAction
 
  --launcher.defaultAction
 
  openFile
 
  openFile
Line 62: Line 52:
 
  --launcher.appendVmargs
 
  --launcher.appendVmargs
 
  -vmargs
 
  -vmargs
−
-Dosgi.requiredJavaVersion=1.8
 
 
  -Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000
 
  -Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000
 
  -Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000
 
  -Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000
 +
-Dosgi.requiredJavaVersion=1.8
 
  -Xms128m
 
  -Xms128m
 
  -Xmx4096m
 
  -Xmx4096m
  
−
==== Links to the repositories ====
+
==== OS.bee P2 Repository ====
 +
 
 +
You will need the link to the P2 repository later in the installation process.
 +
 
 +
The link to the repository is available on the [http://www.osbee.org/free-download/ download page].
 +
 
 +
On the download page, click the checkbox to accept the "Terms of Service and Use".  This will activate the download buttons for the software versions available.  You then click on the button for the version you wish to use. <br> [[File:OSbeeInstall17.PNG]] <br>
 +
 +
Finally, click on "Copy link to clipboard" to copy the URL for the P2 repository to the clipboard.<br> [[File:DownloadCopytoClipboard.PNG|600px]] <br>
 +
 
 +
This URL will be needed during the installation of the OS.bee Software Factory.
  
−
The links to the repositories are available on the [http://www.osbee.org/free-download/ download page].
+
=== Installation of the OS.bee Software Factory ===
  
−
==== Installation ====
+
# Start the new Eclipse installation and select or define a workspace. It is important that each Eclipse installation is assigned to its own workspace.<br><br>[[File:Workspace1.png|600px]]<br><br>
 +
# Go to the menu bar and select Help -> Install New Software....<br><br>[[File:OSbeeInstall04.PNG|600px]]<br><br>
 +
# Get the link to the repository from the [http://www.osbee.org/free-download/ download page], as described above, and paste it into the field labeled '''Work with:'''. Then press '''Enter''' to make Eclipse load the content of the repository.<br> <br>[[File:OSbeeInstall05.PNG|600px]] <br><br>
 +
# Open the "OS.bee Software Factory" group, select the "OS.bee Software Factory" and click on '''Next'''.<br><br>[[File:OSbeeInstall20.png|600px]] <br><br>
 +
# In the installation dialog, confirm the software to be installed by clicking on '''Next'''.<br><br>[[File:OSbeeInstall07.PNG|600px]] <br><br>
 +
# Accept the terms of the license aggreement after reading them carefully, and then confirm the dialog by clicking on '''Finish'''.<br><br>[[File:Eclipse installation agree to licenses.png|600px]]<br><br>
 +
# The installation will now start. This may take a while, depending on your internet connection speed.<br><br>[[File:Install3.PNG|600px]] <br><br>
 +
# After the software has been downloaded, confirm the "Security Warning" dialog by clicking on '''OK'''.<br><br>[[File:InstallUnsignedCodeWarning.png|600px]]<br><br>
 +
# You will then be prompted to '''restart''' Eclipse. Please do so.<br><br>[[File:OSbeeInstall10.PNG|600px]]<br><br>
  
−
* Start the new Eclipse installation and select or define a workspace. Here too, it is important that each Eclipse installation is assigned its own workspace.<br>[[File:Workspace1.png]]<br>
+
=== Set the Target Platform for the OS.bee Software Factory===
−
* Go to the menu bar and select Help -> Install New Software ...<br>
+
−
* Copy the appropriate link to the repository into '''Work with:'''<br>[[File:Setup.png]]<br>
+
−
* Select the "OS.bee Software Factory", confirm the upcoming dialogues and wait for the installation to be finished.<br>
+
−
* confirm the "software to be installed" dialog<br>
+
−
* accept the terms of the license aggreement after you read them carefully and confirm the "Review licenses" dialog by pushing the "Finish" button:<br>[[File:eclipse_installation_agree_to_licenses.png]]<br>
+
−
* confirm the "Security Warning" dialog<br>[[File:install_unsigned_code_warning.png]]<br>
+
−
* You will then be prompted to '''restart''' Eclipse. Please do so!<br>
+
  
−
=== Set Targetplatform for the OS.bee Software Factory===
+
# Check if the workspace you are using is the one you selected above when first opening Eclipse. If not, open the right one.<br><br>
 +
# Set the target platform here: Menu -> Window -> Preferences -> Plug-in Development -> Target Platform.<br><br>
 +
# Click on '''Add...''' to add a new target definition.<br><br>[[File:OSbeeInstall11.PNG|600px]]<br><br>
 +
# Select "Default: ..." and click on '''Next'''.<br><br>[[File:OSbeeInstall12.PNG|600px]]<br><br>
 +
# Click on '''Add...''' to add content, select "Software Site" and click on '''Next'''.<br><br>[[File:OSbeeInstall13.PNG|600px]]<br><br>
 +
# Use the same URL previously saved to the clipboard for the Software Site.<br><br>
 +
# Open the group '''OS.bee Softwarefactory''', select '''OS.bee Softwarefactory Targetplatform (DON'T INSTALL...)''',<br>'''uncheck''' the '''Include required software''' checkbox and click on '''Finish'''.<br><br>[[File:OSbeeInstall14.PNG|600px]]<br><br>
 +
# Change to register '''Content''', enter '''x.a''' in the filter and deactivate the following bundles in the resulting target definition:<br><br><code>javax.annotation version 1.2<br>javax.annotation.source version 1.2</code><br><br>[[File:OSbeeInstall15.PNG|600px]]<br><br>
 +
# '''Do not forget to activate your newly created target definition! '''<br><br>[[File:OSbeeInstall16.PNG|600px]]<br><br>
 +
# Restart Eclipse. You can use Menu -> File -> Restart to do so.<br><br>
  
−
* Check the workspace you are using - is it the one you want to use for the further processing? If not, open the right one.<br>  You can add the parameter <code>-data <path/to/workspace></code> to a shortcut you use to start Eclipse. This will help using the right workspace in the future. It also removes the question about the workspace on Eclipse startup. <br>
 
−
* Then set the targetplatform here: Menu -> Window -> Preferences -> Plug-in Development -> Target Platform<br>[[File:targetplatform.png]]<br>
 
−
* Add a new Target Definition or edit the existing entry.<br>[[File:addnewtarget.png]]<br>
 
−
* Then add content, software site.<br>[[File:addcontent.png]]<br>
 
−
* Use the same link as above for the softwaresite.<br>
 
−
* Select '''OS.bee Software Factory Targetplatform (DON'T INSTALL...)'''<br>and '''uncheck''' the '''include required software''' checkbox.<br>[[File:addcontent2.png]]<br>
 
−
* Change in register '''Content''' and deactivate the following bundles in the resulting target definition.<br><br><code>javax.annotation version 1.2<br>javax.servlet    version 3.1  (may not be present)</code><br><br>[[File:addcontent3.png]]<br>
 
−
* '''Do not forget to activate your new created target definition! '''<br>
 
−
* Restart Eclipse<br><br>... Finish<br>
 
  
−
HEUREKA!
+
You can now continue with [[OS.bee Software Factory Samples]]

Latest revision as of 09:46, 4 May 2017

General information

Copyright Notice

All rights are reserved by Compex Systemhaus GmbH. In particular, duplications, translations, microfilming, saving and processing in electronic systems are protected by copyright. Use of this manual is only authorized with the permission of Compex Systemhaus GmbH. Infringements of the law shall be punished in accordance with civil and penal laws. We have taken utmost care in putting together texts and images. Nevertheless, the possibility of errors cannot be completely ruled out. The Figures and information in this manual are only given as approximations unless expressly indicated as binding. Amendments to the manual due to amendments to the standard software remain reserved. Please note that the latest amendments to the manual can be accessed through our helpdesk at any time. The contractually agreed regulations of the licensing and maintenance of the standard software shall apply with regard to liability for any errors in the documentation. Guarantees, particularly guarantees of quality or durability can only be assumed for the manual insofar as its quality or durability are expressly stipulated as guaranteed. If you would like to make a suggestion, the Compex Team would be very pleased to hear from you.

(c) 2016-2024 Compex Systemhaus GmbH

License information

The OS.bee Software Factory is distributed under a commercial license.

The product itself is based on the OSBP Software Factory which is an Eclipse project. In addition, the software depends on several other open source projects, and the entire list of licenses used can be found here.

Installation of the Software Factory

Before you start

Java Version

To be able to use the OS.bee Software Factory, you need to have the right Java version installed.

On Windows, this is Java JDK 8 64bit Java SE Downloads. If you have Java installed, there is generally a Java icon on the control panel which will enable you to find out the current version.

Eclipse Version

To be able to use the OS.bee Software Factory, you need to have the correct Eclipse version installed. You can use Eclipse Luna DSL Developers SR2. Download and extract it to a folder location of your choosing. On Windows, we recommend C:\. This results in the installation folder C:\eclipse. This will be the assumed Eclipse installation folder for the rest of this document.

To be able to launch Eclipse easily, create a shortcut to the program C:\eclipse\eclipse.exe on the computer's desktop . Be sure to add the parameter -data /path/to/your/workspace to the shortcut's invocation of Eclipse in order to start in the correct workspace in the future. Otherwise, you will be prompted to specify a workspace each time you start Eclipse.

Make the following additions / changes to the eclipse.ini file found in the C:\eclipse folder:

-Dosgi.requiredJavaVersion=1.8
-Xmx4096m
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000

The first line ensures that the required Java version is used. The second allocates extra memory for Eclipse to use and the last two help to avoid timeout problems with servers that respond slowly.

A resulting eclipse.ini file for a Windows installation might look like this:

-startup plugins/org.eclipse.equinox.launcher_1.3.0.v20140415-2008.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.200.v20150204-1316
-product org.eclipse.epp.package.dsl.product
--launcher.defaultAction
openFile
--launcher.XXMaxPermSize
256M
-showsplash
org.eclipse.platform
--launcher.XXMaxPermSize
256m
--launcher.defaultAction
openFile
--launcher.appendVmargs
-vmargs
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.closeTimeout=3000
-Dorg.eclipse.ecf.provider.filetransfer.retrieve.readTimeout=3000
-Dosgi.requiredJavaVersion=1.8
-Xms128m
-Xmx4096m

OS.bee P2 Repository

You will need the link to the P2 repository later in the installation process.

The link to the repository is available on the download page.

On the download page, click the checkbox to accept the "Terms of Service and Use". This will activate the download buttons for the software versions available. You then click on the button for the version you wish to use.
OSbeeInstall17.PNG

Finally, click on "Copy link to clipboard" to copy the URL for the P2 repository to the clipboard.
DownloadCopytoClipboard.PNG

This URL will be needed during the installation of the OS.bee Software Factory.

Installation of the OS.bee Software Factory

  1. Start the new Eclipse installation and select or define a workspace. It is important that each Eclipse installation is assigned to its own workspace.

    Workspace1.png

  2. Go to the menu bar and select Help -> Install New Software....

    OSbeeInstall04.PNG

  3. Get the link to the repository from the download page, as described above, and paste it into the field labeled Work with:. Then press Enter to make Eclipse load the content of the repository.

    OSbeeInstall05.PNG

  4. Open the "OS.bee Software Factory" group, select the "OS.bee Software Factory" and click on Next.

    OSbeeInstall20.png

  5. In the installation dialog, confirm the software to be installed by clicking on Next.

    OSbeeInstall07.PNG

  6. Accept the terms of the license aggreement after reading them carefully, and then confirm the dialog by clicking on Finish.

    Eclipse installation agree to licenses.png

  7. The installation will now start. This may take a while, depending on your internet connection speed.

    Install3.PNG

  8. After the software has been downloaded, confirm the "Security Warning" dialog by clicking on OK.

    InstallUnsignedCodeWarning.png

  9. You will then be prompted to restart Eclipse. Please do so.

    OSbeeInstall10.PNG

Set the Target Platform for the OS.bee Software Factory

  1. Check if the workspace you are using is the one you selected above when first opening Eclipse. If not, open the right one.

  2. Set the target platform here: Menu -> Window -> Preferences -> Plug-in Development -> Target Platform.

  3. Click on Add... to add a new target definition.

    OSbeeInstall11.PNG

  4. Select "Default: ..." and click on Next.

    OSbeeInstall12.PNG

  5. Click on Add... to add content, select "Software Site" and click on Next.

    OSbeeInstall13.PNG

  6. Use the same URL previously saved to the clipboard for the Software Site.

  7. Open the group OS.bee Softwarefactory, select OS.bee Softwarefactory Targetplatform (DON'T INSTALL...),
    uncheck the Include required software checkbox and click on Finish.

    OSbeeInstall14.PNG

  8. Change to register Content, enter x.a in the filter and deactivate the following bundles in the resulting target definition:

    javax.annotation version 1.2
    javax.annotation.source version 1.2

    OSbeeInstall15.PNG

  9. Do not forget to activate your newly created target definition!

    OSbeeInstall16.PNG

  10. Restart Eclipse. You can use Menu -> File -> Restart to do so.


You can now continue with OS.bee Software Factory Samples

Retrieved from "https://download.osbee.org/documentation/index.php?title=OS.bee_Software_Factory_Installation_Luna&oldid=1722"