Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Stardust/Knowledge Base/Getting Started/Installation"

(Online Eclipse Update Site)
(Product Documentation)
(109 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{warning2|text=While we are preparing a binary download and an online eclipse update site for Stardust<br> please download the source code and build Stardust as described [[Stardust/Source Code | here]]. Then follow the installation instructions for a local update site.
+
== Installation Alternatives  ==
}}
+
  
== Introduction  ==
+
Installation of Stardust is performed by installing the corresponding Stardust Features and their required dependencies. These Eclipse Features include the
  
To get started you need to install an ''Eclipse Helios'' including the required dependencies and the ''Process Workbench Eclipse features''. These features include the process modeller, the rapid application development (RAD) environment and the report designer extension.  
+
*Process Modeller,  
 +
*the Rapid Application Development (RAD) environment and the  
 +
*Report Designer Extension.
  
After installing Eclipse and dependencies as described in the following section "Eclipse Installation" you have several options to add the ''Processworbench Eclipse features'' to it:  
+
You have several options to add the '''Stardust - Eclipse Process Manager''' Features and their dependencies to your Eclipse environment:  
  
 
*'''Online Eclipse update site''' - This is a good choice if you:<br>- don't know what to choose<br>- have a reliable, fast internet connection<br>- only want to install on a single PC / environment<br>- want to check for updates frequently and intend to update to the latest and greatest version frequently<br>  
 
*'''Online Eclipse update site''' - This is a good choice if you:<br>- don't know what to choose<br>- have a reliable, fast internet connection<br>- only want to install on a single PC / environment<br>- want to check for updates frequently and intend to update to the latest and greatest version frequently<br>  
*'''Local Eclipse update site''' '''(offline)''' - This is a good choice if you:<br>- have a not so fast and reliable internet connection<br>- have an internet connection with high latency / response times<br>- want to install on multiple PCs / environments<br>- are going to check for updates less frequently or not via the built-in update mechanism<br>- may not always upgrade to the latest patch release<br>  
+
*'''Local Eclipse update site''' - This is a good choice if you:<br>- have a not so fast and reliable internet connection<br>- have an internet connection with high latency / response times<br>- want to install on multiple PCs / environments<br>- are going to check for updates less frequently or not via the built-in update mechanism<br>- may not always upgrade to the latest patch release<br>  
*'''Install features as drop-ins (offline)''' - This is a good choice if you:<br>- know what you are doing<br>- are sure that you have the right Eclipse version with all required dependencies installed<br>- are familiar enough with the eclipse plug-in mechanism and know how to install missing dependencies if needed<br>- rather perform some steps in the file system than walk through the dialogs of the (local) Eclipse update site installation<br>- want to separate the new features from you Eclipse installation on file system level<br>- want to automate the installation for multiple environments
+
*'''Install features as drop-ins''' - This is a good choice if you:<br>- know what you are doing<br>- are sure that you have the right Eclipse version with all required dependencies installed<br>- are familiar enough with the eclipse plug-in mechanism and know how to install missing dependencies if needed<br>- rather perform some steps in the file system than walk through the dialogs of the (local) Eclipse update site installation<br>- want to separate the new features from you Eclipse installation on file system level<br>- want to automate the installation for multiple environments<br>
  
<br>
+
== Online Eclipse Update Site  ==
  
== Eclipse Installation<br>  ==
+
=== Install Eclipse 4.3.2 (Kepler SR2) for Java and Report Developers ===
  
==== The right Eclipse Version<br>  ====
+
*Go to [http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-report-developers/keplersr2 Eclipse IDE for Java and Report Developers] download page
 +
*Download and unzip to your hard drive
  
The Process Workbench is based on the [http://www.eclipse.org Eclipse Platform] and consists of the combination of the basic Eclipse platform and a number of plug-ins. Currently only Eclipse Helios Service Release 2 (Eclipse 3.6 SR2, build 20110218-0911) is supported. Please make sure to download the appropriate version for your operating system. It’s strongly recommended to download the bundle '''Eclipse IDE for Java and Report Developers''' [http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-report-developers/heliossr2 here] to avoid having to install additional missing plug-ins at a later point.<br>
+
=== Install Stardust  ===
  
After downloading, install Eclipse by extracting it into a target folder of your choice. Start the Eclipse application. When the Eclipse IDE opens for the first time you are presented with a ''Welcome'' screen, which you may close.  
+
*'''Open''' context menu&nbsp;'''Help &gt; Install New Software...'''
 +
*Select '''"http://download.eclipse.org/releases/kepler"''' from the dropdown box of "Work with"
 +
*'''Open '''the category '''SOA Development '''and '''Select&nbsp;'''all features for '''''"''Eclipse Process Manager ..."'''
 +
[[Image:Install-stardust-1.1.2.png]]
 +
*Select '''Next''' for the follow-up screens and accept the '''Eclipse License Agreement'''.
 +
*Select '''Finish''' - all Stardust components will be downloaded now. This may take 10-20 minutes depending on your network connection.
 +
*'''Restart''' Eclipse after installation has completed.
  
==== The Subclipse Plug-ins<br>  ====
+
Congratulations! You are ready to use the Stardust Eclipse Process Manager.
  
The Collaborative Modeling feature requires Subclipse 1.6.18. The fastest and most stable way to install Subclipse plug-ins is to download the local update site from [http://subclipse.tigris.org/files/documents/906/49028/site-1.6.18.zip here], extract it to your local drive and install it into Eclipse from there.<br>
+
=== Next Steps  ===
  
#In your Eclipse Go to: Help &gt; Install New Software...
+
Now you are ready to start the process modeler and configure the Rapid Application Development. Please consult the product documentation for further instructions.
#Add a new local update site named "Subclipse" pointing to the location to which you have previously extracted the Subclipse zip archive
+
#Select the newly created local update site "Subclipse" in the "Work with" selection<br>
+
#Select check the plug-ins as shown in the screenshot below
+
#Confirm all follow-up screens
+
#Restart Eclipse after installation
+
  
<br>
+
===== Product Documentation  =====
  
[[Image:subclipse.png]]
+
Documentation for your first steps can be found under
  
<br>
+
*'''Help &gt; Help Contents''', select '''Stardust Online Documentation''' or
 +
*online at [http://help.eclipse.org/kepler/topic/org.eclipse.stardust.docs.dev/html/toc.html http://help.eclipse.org/]
  
== Process Workbench Eclipse Feature Installation  ==
+
You may want to start with a first tutorial: the Support-Case Example&nbsp;[http://help.eclipse.org/kepler/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/tutorial/support-case/support-case-preface.htm here].
  
=== Online Eclipse Update Site  ===
+
== Local Eclipse Update Site  ==
  
After the installation of Eclipse and the Subclipse plug-ins the ''Processworkbench Eclipse features'' can be installed. This section describes how to do this using the online Eclipse update site.<br> (See the introduction for other options).<br>
+
=== Build Stardust from Source Code  ===
  
#Go to: Help &gt; Install New Software...
+
If you like to build Stardust, please download the source code and build Stardust as described [[Stardust/Source_Code|here]].
#Add a new remote update site named "Stardust" pointing to <u>''http://download.eclipse.org/stardust/nightly/''</u>
+
#Select the check box ''Eclipse Process Manager - Modeling''
+
#Confirm all possible follow-up screens
+
#Restart Eclipse after the installation has completed.
+
  
<br>
+
=== Install Local Eclipse Update Site (offline)  ===
  
[[Image:Installing Stardust via Eclipse update 01.png]]  
+
For one of the reasons mentioned in the introduction you may prefer to download the complete update site so you can use it as a local Eclipse update and install the Stardust - Eclipse Process Manager features offline, possibly to multiple environments.&nbsp;The zipped complete Eclipse update site can be downloaded from the repository ([[Stardust/Download|see Downloads]]).&nbsp;Please note that the suffix of the archive name depends on the planned release version and a consecutively build number.
  
<br>  
+
Or you want to install your locally build Stardust update.<br>  
  
'''Note:''' Select '''Infinity Process Platform Visual Rules Integration''' only if this functionality is required and '''Visual Rules 5 RN36-201012152047''' plug-in bundle has been installed up-front. If Subclipse plug-ins have not been installed already, please deselect '''Infinity Modeling VCS-Connector''' plug-in.  
+
#Open the context menu&nbsp;'''Help &gt; Install New Software...'''
 +
#Push '''Add''' button
 +
#Enter Name: Stardust local site and Location: &lt;YourLocalStardust.zipLocation&gt;
 +
#'''Select''' the check box '''Stardust - Eclipse Process Manager'''  
 +
#Select '''Next''' for the follow-up screens and accept the '''Eclipse License Agreement'''.  
 +
#Select '''Finish''' - all Stardust components will be downloaded now.
 +
#For your local builds, you may receive a warning that the software contains unsigned content, which you need to ignore.
 +
#'''Restart''' Eclipse after installation has completed.
  
Screenshot: Login screen
+
== Install Features as Drop-ins  ==
  
[[Image:Installing Stardust via Eclipse update 04.png]]  
+
Please refer to the Eclipse Platform Plug-in Developer Guide's section "[http://help.eclipse.org/kepler/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_format.html The drop-ins folder and supported file layouts]".
  
<br>
+
Remember start Eclipse using the parameter -clean after making modifications to the drop-ins folder.
  
Screenshot: Selected plug-ins screen
+
== Runtime Environment via Maven ==
 +
Please see [[Stardust/Knowledge_Base/Build_and_Change_Management/Maven/Basic_Setup|Maven section of the Knowledge Base]]
  
[[Image:Installing Stardust via Eclipse update 05.png]]
 
  
<br>
+
== Product Documentation  ==
  
Screenshot: Review screen
+
Documentation for your first steps can be found under
  
'''[[Image:Installing Stardust via Eclipse update 06.png]]'''  
+
*'''Help &gt; Help Contents''', select '''Stardust Online Documentation''' or
 +
*online at [http://help.eclipse.org/kepler/topic/org.eclipse.stardust.docs.dev/html/toc.html http://help.eclipse.org/kepler/topic/org.eclipse.stardust.docs.dev/html/toc.html]
  
<br>
+
You may want to start with a first tutorial: the Support-Case Example [http://help.eclipse.org/kepler/topic/org.eclipse.stardust.docs.dev/html/handbooks/tutorial/support-case/support-case-preface.htm here].
 
+
Screenshot: License Agreement screen
+
 
+
'''[[Image:Installing Stardust via Eclipse update 07.png]]'''
+
 
+
<br>
+
 
+
Screenshot: Installation progress screen
+
 
+
'''[[Image:Installing Stardust via Eclipse update 08.png]]'''
+
 
+
Once installation is finished, a dialog appears suggesting to restart, which you should do. The Process Workbench requires a license file to be present. To load it, select '''Preferences''' and go to the '''Infinity''' section. Type the path to the license file or click '''Browse''' to locate it. Click '''Apply''' or '''OK.'''
+
 
+
[[Image:Installing Stardust via Eclipse update 09.png]]'''<br>'''
+
 
+
<br>
+
 
+
Turn to the integrated documentation or to the [https://infinity.sungard.com/documentation/ipp/6.0/index.jsp online documentation] to learn more about the Process Workbench. The documentation for the Process Workbench can be found under the '''Help &gt; Help Contents''' menu item and then selecting the chapter for '''Infinity Process Platform Documentation'''.
+
 
+
Enjoy using Infinity Process Workbench until you can use it as Stardust as an even more integral part of the Eclipse project!<br>
+
 
+
=== Local Eclipse Update Site (offline)  ===
+
 
+
For one of the reasons mentioned in the introduction you may prefer to download the complete update site so you can use it as a local Eclipse update and install the Process Workbench Eclipse Features offline, possibly to multiple environments. The zipped complete Eclipse update site can be downloaded from the repository<br> [https://infinity.sungard.com/repository/ipp-eclipse-features/ipp-6.0.4/offlineSite.zip https://infinity.sungard.com/repository/ipp-eclipse-features/ipp-6.0.4/offlineSite.zip]. (Replace the version number in the URL according to your needs)<br>
+
 
+
Download the zip file and extract it to your local disk. The installation of the right Eclipse version and of Subclipse as described in the section "Eclipse Installation" is still a pre-condition.<br>
+
 
+
#Go to Help &gt; Install New Software...
+
#Add a new local update site "IPP" pointing to the location to which you have extracted the offlineSite.zip archive
+
#Select the created local update site and select Infinity Process Platform - Process Workbench 6.x.x
+
#Confirm all possible follow-up screens
+
#Restart Eclipse after installation
+
 
+
(see section "Online Eclipse Update Site" for more details)<br>
+
 
+
=== Install Features as Drop-ins (offline)<br>  ===
+
 
+
Please refer to the Eclipse Platform Plug-in Developer Guide's section "[http://help.eclipse.org/helios/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_format.html The drop-ins folder and supported file layouts]".<br>
+
 
+
Remember start Eclipse using the parameter -clean after making modifications to the drop-ins folder.
+
 
+
<br>
+
 
+
== Retrieving Artifacts from the Maven Repository  ==
+
<pre>If you just want to get started quickly, create a process model and possibly use the rapid application development
+
(RAD) environment to execute it then you don't need this. In that case please continue with the
+
"Where to go from here" section.
+
</pre>
+
Additionally to the Process Workbench Eclipse features the following artifacts and scripts can be found in the Maven repository:
+
 
+
*[[STP/Stardust/KnowledgeBase/BuildChangeMgmt/Maven|Maven Archetypes]] - Generate Maven projects for different engine runtime, reporting runtime and client environments as well as for the administrative command line tools<br>
+
*Runtime artifacts Used by Maven, Ivy or other rebuild tools to build runtime environments (WARs / EARs)<br>
+
*Client scripts Used by Maven or Ivy to generate client environments for the command line tools<br>
+
*Spring configuration files - Used by Maven, Ivy or other build tools to build Spring client and runtime environments<br>
+
*Web artifacts like deployable archives and configuration snippets
+
*Infinity Scan component
+
 
+
The Maven archetype is defined in the [https://infinity.sungard.com/repository/ipp-releases/archetype-catalog.xml archetype-catalog.xml].
+
 
+
The other artifacts can be download directly from the repository location [https://infinity.sungard.com/repository/ipp-libs/com/infinity/bpm/ipp-tools https://infinity.sungard.com/repository/ipp-libs/com/infinity/bpm/ipp-tools]&nbsp;<br>or using Ivy integrated Ant tasks as described [[STP/Stardust/KnowledgeBase/BuildChangeMgmt/Ivy|here]].
+
 
+
We recommend to [[Stardust/Knowledge Base/Build and Change Management/Maven/Basic Setup#M2_Eclipse_Plugin|install the M2 Eclipse plugin]] which allows you to work comfortably with Maven from inside Eclipse. Starting with Eclipse 3.7 this plugin may already be shipped with your Eclipse installation.<br>
+
 
+
== Where to go from here<br>  ==
+
 
+
We suggest to have look at the [http://www.eclipse.org/stardust/documentation/training-videos.php training videos] and the [https://infinity.sungard.com/documentation/ipp/6.0/index.jsp?topic=/ag.carnot.docs.dev/html/handbooks/modelling/model-views/views-cheat.html Tutorial] in the product documentation.
+
 
+
Also go to the Stardust [[Stardust/Knowledge Base|Knowledge Base]] to find How-Tos, API Cookbook, articles, advanced tutorials and more material that will help you to get your project running quickly.<br>
+
 
+
<br>
+
 
+
== Upgrading Installed Features  ==
+
 
+
The installed Process Workbench Eclipse Features can be upgrade to a new version or downgraded to previously installed version. To upgrade your installed features to a later version provided via an update site perform the following steps:<br>
+
 
+
#In the main menu, select '''Help &gt; Check for Updates'''.
+
 
+
[[Image:Check-for-updates.png]]<br>
+
 
+
#The '''Available Updates''' dialog opens. Select the updates you like to install. In the '''Version''' column, the newest version to update to is displayed.
+
 
+
[[Image:Stardust Select-updates.png]]<br>
+
 
+
#Review and confirm your selected updates and click '''Next'''.<br>
+
#Accept the license and select '''Finish'''.
+
#Restart Eclipse.
+
 
+
<br>
+
 
+
If upgrading to a new version in an already configured environment you also need to perform the necessary steps to upgrade your Web project and process model(s) as described in the product documentation chapter "Upgarding to later Versions".[[|]]
+
 
+
<br>
+

Revision as of 17:16, 2 March 2014

Installation Alternatives

Installation of Stardust is performed by installing the corresponding Stardust Features and their required dependencies. These Eclipse Features include the

  • Process Modeller,
  • the Rapid Application Development (RAD) environment and the
  • Report Designer Extension.

You have several options to add the Stardust - Eclipse Process Manager Features and their dependencies to your Eclipse environment:

  • Online Eclipse update site - This is a good choice if you:
    - don't know what to choose
    - have a reliable, fast internet connection
    - only want to install on a single PC / environment
    - want to check for updates frequently and intend to update to the latest and greatest version frequently
  • Local Eclipse update site - This is a good choice if you:
    - have a not so fast and reliable internet connection
    - have an internet connection with high latency / response times
    - want to install on multiple PCs / environments
    - are going to check for updates less frequently or not via the built-in update mechanism
    - may not always upgrade to the latest patch release
  • Install features as drop-ins - This is a good choice if you:
    - know what you are doing
    - are sure that you have the right Eclipse version with all required dependencies installed
    - are familiar enough with the eclipse plug-in mechanism and know how to install missing dependencies if needed
    - rather perform some steps in the file system than walk through the dialogs of the (local) Eclipse update site installation
    - want to separate the new features from you Eclipse installation on file system level
    - want to automate the installation for multiple environments

Online Eclipse Update Site

Install Eclipse 4.3.2 (Kepler SR2) for Java and Report Developers

Install Stardust

  • Open context menu Help > Install New Software...
  • Select "http://download.eclipse.org/releases/kepler" from the dropdown box of "Work with"
  • Open the category SOA Development and Select all features for "Eclipse Process Manager ..."

Install-stardust-1.1.2.png

  • Select Next for the follow-up screens and accept the Eclipse License Agreement.
  • Select Finish - all Stardust components will be downloaded now. This may take 10-20 minutes depending on your network connection.
  • Restart Eclipse after installation has completed.

Congratulations! You are ready to use the Stardust Eclipse Process Manager.

Next Steps

Now you are ready to start the process modeler and configure the Rapid Application Development. Please consult the product documentation for further instructions.

Product Documentation

Documentation for your first steps can be found under

You may want to start with a first tutorial: the Support-Case Example here.

Local Eclipse Update Site

Build Stardust from Source Code

If you like to build Stardust, please download the source code and build Stardust as described here.

Install Local Eclipse Update Site (offline)

For one of the reasons mentioned in the introduction you may prefer to download the complete update site so you can use it as a local Eclipse update and install the Stardust - Eclipse Process Manager features offline, possibly to multiple environments. The zipped complete Eclipse update site can be downloaded from the repository (see Downloads). Please note that the suffix of the archive name depends on the planned release version and a consecutively build number.

Or you want to install your locally build Stardust update.

  1. Open the context menu Help > Install New Software...
  2. Push Add button
  3. Enter Name: Stardust local site and Location: <YourLocalStardust.zipLocation>
  4. Select the check box Stardust - Eclipse Process Manager
  5. Select Next for the follow-up screens and accept the Eclipse License Agreement.
  6. Select Finish - all Stardust components will be downloaded now.
  7. For your local builds, you may receive a warning that the software contains unsigned content, which you need to ignore.
  8. Restart Eclipse after installation has completed.

Install Features as Drop-ins

Please refer to the Eclipse Platform Plug-in Developer Guide's section "The drop-ins folder and supported file layouts".

Remember start Eclipse using the parameter -clean after making modifications to the drop-ins folder.

Runtime Environment via Maven

Please see Maven section of the Knowledge Base


Product Documentation

Documentation for your first steps can be found under

You may want to start with a first tutorial: the Support-Case Example here.

Back to the top