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"

m
(Install Stardust)
(153 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Eclipse Update Site ==
+
== Installation Alternatives ==
  
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 which can be installed from the online update site. Currently the IPP plug-ins are only supported for the Eclipse version [http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-report-developers/heliossr2 Eclipse Helios Sr2 (3.6.2)]. Please make sure to download exactly the version appropriate for your operating system. It’s recommended to download the bundle '''Eclipse IDE for Java and Report Developers''' to avoid downloading BIRT-related plug-ins at later point via Eclipse update site.
+
Installation of Stardust is performed by installing the corresponding Stardust Features and their required dependencies. These Eclipse Features include the  
  
After downloading, install Eclipse by unzipping 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.
+
*Process Modeller,  
 +
*the Rapid Application Development (RAD) environment and the  
 +
*Report Designer Extension.
  
In order to use Collaborative Modeling feature you will be needing the VCS-Connector plug-in, which itself requires Subclipse 1.6.17. 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 prior any Infinity Process Platform related installation activities.
+
You have several options to add the '''Stardust - Eclipse Process Manager''' Features and their dependencies to your Eclipse environment:
  
<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''' - 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''' - 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>
  
# Go to Help &gt; Install New Software...
+
== Online Eclipse Update Site  ==
# Add new local update site Subclipse pointing to the location to where you have extracted Subclipse archive
+
# Chose newly created local update site and select plug-ins such as shown in screenshot below
+
# Confirm all possible follow up screens
+
# Restart Eclipse after installation
+
  
<br>
+
=== Install Eclipse IDE for Java EE Developers ===
  
[[Image:Installing Stardust via Eclipse update 02.png]]  
+
*Go to [http://www.eclipse.org/downloads/ Eclipse download page] and download '''Eclipse IDE for Java EE Developers'''
 +
*Download and unzip to your hard drive
  
<br>
+
=== Install Stardust  ===
  
After installation of Subclipse plug-ins, Infintiy Process Platform related plug-ins can be installed.  
+
*'''Open''' context menu&nbsp;'''Help &gt; Install New Software...'''
 +
*Select '''"http://download.eclipse.org/releases/mars"''' from the dropdown box of "Work with"
 +
*'''Open '''the category '''SOA Development '''and '''Select&nbsp;'''all features for '''''"''Eclipse Process Manager ..."'''
 +
[[Image:Install-stardust-3.0.0.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.
  
# Go to Help > Install New Software...
+
Congratulations! You are ready to use the Stardust Eclipse Process Manager.
# Add new remote update site IPP pointing to https://infinity.sungard.com/repository/ipp-eclipse-features/
+
# Chose IPP remote update site and when asked for a login type in the credentials (e-mail/password) you used when registering at the Infinity Storefront
+
# Select Infinity Process Platform - Process Workbench 6.x
+
# Confirm all possible follow up screens
+
# Restart Eclipse after installation
+
  
<br>
+
=== Next Steps  ===
  
[[Image:Installing Stardust via Eclipse update 01.png]]
+
Now you are ready to start the process modeler and configure the Rapid Application Development. Please consult the product documentation for further instructions.  
  
<br>
+
===== Product Documentation  =====
  
<p>'''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 unselect '''Infinity Modeling VCS-Connector''' plug-in.</p>
+
Documentation for your first steps can be found under
  
<p>'''Note:''' Alternatively you can install Infinity Process Platform via local update site. For this you have to download the artifacts from the repository under https://infinity.sungard.com/repository/ipp-eclipse-features/ipp-6.0.2/offlineSite.zip.  
+
*'''Help &gt; Help Contents''', select '''Stardust Online Documentation''' or
Replace the version number part of the URL according to your needs.</p>
+
*online at [http://help.eclipse.org/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/toc.html http://help.eclipse.org/]
  
 +
You may want to start with a first tutorial: the Support-Case Example&nbsp;[http://help.eclipse.org/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/tutorial/support-case/support-case-preface.htm here].
  
<br>
+
== Local Eclipse Update Site  ==
  
<p>Screenshot: Login screen</p>
+
=== Build Stardust from Source Code  ===
[[Image:Installing Stardust via Eclipse update 04.png]]
+
  
<br>
+
If you like to build Stardust, please download the source code and build Stardust as described [[Stardust/Source_Code|here]].
  
<p>Screenshot: Selected plug-ins screen</p>
+
=== Install Local Eclipse Update Site (offline)  ===
[[Image:Installing Stardust via Eclipse update 05.png]]
+
  
<br>
+
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.
  
<p>Screenshot: Review screen</p>
+
Or you want to install your locally build Stardust update.<br>
'''[[Image:Installing Stardust via Eclipse update 06.png]]'''
+
  
<br>
+
#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.
  
<p>Screenshot: License Agreement screen</p>
+
== Install Features as Drop-ins  ==
'''[[Image:Installing Stardust via Eclipse update 07.png]]'''
+
  
<br>
+
Please refer to the Eclipse Platform Plug-in Developer Guide's section "[http://help.eclipse.org/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_format.html The drop-ins folder and supported file layouts]".
  
<p>Screenshot: Installation progress screen</p>
+
Remember start Eclipse using the parameter -clean after making modifications to the drop-ins folder.
'''[[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.'''
+
== 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 09.png]]'''<br>'''
 
  
Turn to the integrated documentation to learn more about the Process Workbench. The included documentation for the Process Workbench can be found under the '''Help &gt; Help Contents''' menu item and then selecting the chapter for [[STP/Stardust/KnowledgeBase#Product_Documentation|'''Infinity Process Platform Documentation''']].
+
== Product Documentation ==
  
Enjoy using Infinity Process Workbench until you can use it as Stardust as an even more integral part of the Eclipse project!<br>
+
Documentation for your first steps can be found under
  
== Receiving Artifacts from the Maven Repository  ==
+
*'''Help &gt; Help Contents''', select '''Stardust Online Documentation''' or
 +
*online at [http://help.eclipse.org/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/toc.html http://help.eclipse.org/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/toc.html]
  
Additionally to the Workbench Artifacts, Infinity provides the following artifacts and scripts:  
+
You may want to start with a first tutorial: the Support-Case Example [http://help.eclipse.org/index.jsp?topic=/org.eclipse.stardust.docs.dev/html/tutorial/support-case/support-case-preface.htm here].
 
+
*Runtime artifacts
+
*Client scripts
+
*Spring configurations
+
*Web artifacts like deployable archives and configuration snippets
+
*Infinity Scan
+
 
+
These components are available by the <tt>ipp-tools</tt> artifact. You can download this artifact directly from the artifactory from the following 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/]
+
 
+
or by an Ivy integrated Ant task as described in the following section.
+
 
+
*[[#ivySnippets|Retrieving the Artifacts via Ivy Integrated Ant Tasks]]
+
*[[#buildWork|Building your Work Environment via Ivy Integrated Ant Tasks]]
+
*[[#thirdparty|Including Thirdparty Libraries]]<br>
+
 
+
=== Retrieving the Artifacts via Ivy Integrated Ant Tasks  ===
+
 
+
You can use Apache Ivy ant tasks to receive the artifacts and build your work environment. For details on using Ivy, please refer to the [http://ant.apache.org/ivy/ Apache Ivy Site].  
+
 
+
You can use the following code snippets for the files needed to be configured:<br>
+
 
+
'''ivy.xml'''<br>
+
<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+
&lt;ivy-module version="2.0" xmlns:m="http://ant.apache.org/ivy/maven" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
xsi:noNamespaceSchemaLocation="http://ant.apache.org/ivy/schemas/ivy.xsd"&gt;
+
  &lt;info organisation="&lt;organisation.name&gt;" module="&lt;ipp-client-tool&gt;" revision="&lt;x.y.z&gt;" /&gt;
+
  &lt;configurations&gt;
+
    &lt;conf name="ipp-tools" /&gt;
+
  &lt;/configurations&gt;
+
  &lt;dependencies&gt;
+
    &lt;dependency org="com.infinity.bpm" name="ipp-tools" rev="" conf="ipp-tools-&gt;default"&gt;
+
      &lt;artifact name="ipp-tools" type="zip"/&gt;
+
    &lt;/dependency&gt;
+
  &lt;/dependencies&gt;
+
&lt;/ivy-module&gt;
+
</pre>
+
'''|ivy-settings.xml'''<br>
+
<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+
&lt;ivysettings&gt;
+
  &lt;property name="ipp.m2.repository" value="https://internal.csa.sungard.com/artifactory" override="false"/&gt;
+
  &lt;property name="default.ivy.cache" value="/.cache" override="false"/&gt;
+
  &lt;caches&gt;
+
    &lt;cache name="ipp-tools-ivy-cache" basedir="" useOrigin="true" /&gt;
+
  &lt;/caches&gt;
+
  &lt;resolvers&gt;
+
    &lt;ibiblio name="ipp-releases" root="/ipp-libs" m2compatible="true" cache="ipp-tools-ivy-cache"/&gt;
+
  &lt;/resolvers&gt;
+
  &lt;settings defaultResolver="ipp-releases"/&gt;
+
&lt;/ivysettings&gt;
+
</pre>
+
'''build.xml'''
+
<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+
&lt;project name="retrieve-ipp-tools" default="retrieve-ipp-tools" xmlns:ivy="antlib:org.apache.ivy.ant"&gt;
+
&lt;property name="ivy.install.version" value="2.2.0" /&gt;
+
&lt;property name="ivy.jar.dir" value="/ivy" /&gt;
+
&lt;property name="ivy.jar.file" value="/ivy.jar" /&gt;
+
&lt;property name="ivy.settings.file" value="ivy-settings.xml" /&gt;
+
&lt;property name="m2.server.host" value="internal.csa.sungard.com" /&gt;
+
&lt;property name="m2.server.auth.realm" value="Artifactory Realm" /&gt;
+
&lt;property name="m2.server.auth.username" value="&lt;i&gt;username&lt;/i&gt;" /&gt;
+
&lt;property name="m2.server.auth.password" value="&lt;i&gt;password&lt;/i&gt;" /&gt;
+
&lt;property name="ipp.version" value="latest.integration" /&gt;
+
&lt;!-- Downloading ivy --&gt;
+
&lt;target name="download-ivy" unless="skip.download" description="Downloading ivy"&gt;
+
  &lt;mkdir dir=""/&gt;
+
  &lt;get src="http://repo1.maven.org/maven2/org/apache/ivy/ivy//ivy-.jar" dest="" usetimestamp="true"/&gt;
+
&lt;/target&gt;
+
&lt;!-- Installing ivy --&gt;
+
&lt;target name="install-ivy" depends="download-ivy" description="Installing ivy"&gt;
+
  &lt;path id="ivy.lib.path"&gt;
+
    &lt;fileset dir="" includes="*.jar"/&gt;
+
  &lt;/path&gt;
+
  &lt;taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path"/&gt;
+
&lt;/target&gt;
+
&lt;!-- Setting up ivy --&gt;
+
&lt;target name="setup-ivy" depends="install-ivy" description="Setting up ivy"&gt;
+
  &lt;ivy:settings id="ivy.instance" file=""&gt;
+
    &lt;ivy:credentials host="" realm="" username="" passwd="" /&gt;
+
  &lt;/ivy:settings&gt;
+
&lt;/target&gt;
+
&lt;!-- Retrieving IPP Tools --&gt;
+
&lt;target name="retrieve-ipp-tools" depends="setup-ivy" description="Retrieving IPP Tools"&gt;
+
  &lt;ivy:resolve/&gt;
+
  &lt;ivy:retrieve conf="ipp-tools" pattern="[artifact].[ext]" type="zip"/&gt;
+
  &lt;unzip dest="." src="ipp-tools.zip"/&gt;
+
&lt;/target&gt;
+
&lt;/project&gt;
+
</pre>
+
Run the build file to retrieve the <tt>ipp-tools.zip</tt> archive. Please take care to use the right proxy settings in your Java environment.
+
 
+
== Building your Work Environment via Ivy Integrated Ant Tasks  ==
+
 
+
Unzip the downloaded or created <tt>ipp-tools.zip</tt> file.
+
 
+
After doing so, you find a <tt>ipp-ivy-cred.properties</tt> file in the <tt>etc</tt> folder. Open this file and set the appropriate user and password, e.g.:
+
<pre>m2.server.host = internal.csa.sungard.com
+
m2.server.auth.realm = Artifactory Realm
+
m2.server.auth.username = &lt;i&gt;username&lt;/i&gt;
+
m2.server.auth.password = &lt;i&gt;password&lt;/i&gt;</pre>
+
All needed Ivy files are downloaded as well:<br>
+
 
+
*'''ivy.xml''' - to declare the project's modules and dependencies.
+
*'''ivy-settings.xml''' - to configure artifact resolution.
+
*'''build.xml''' - to execute the ANT tasks for artifact resolution.
+
 
+
Now execute the ANT target <tt>retrieve-ipp-tools</tt>, which you find in the provided <tt>build.xml</tt> file.
+
 
+
All artifacts like documentation, runtime, client scripts etc., will be downloaded. To get an overview about the runtime dependencies, you can execute the ANT target <tt>report</tt> of the <tt>build.xml</tt> file. Per default, the latest integration is used to retrieve the appropriate version. Thus, you always get the latest version, that can be found in the repository. If you are interested in a specific version, you can either pass the version via a parameter, e.g.
+
<pre>&lt;tt&gt;-Dipp.version=6.0.2&lt;/tt&gt;</pre>
+
or you can permanently store this parameter in the <tt>etc/build.properties</tt> file.
+
 
+
== Including Third party Libraries  ==
+
 
+
You need to set up a custom repository to include the following third party libraries:
+
 
+
*jai-imageio-1.1.jar - javax.media.group-id
+
*stax-ex-1.0.jar - org.jvnet.staxex
+
*streambuffer-0.4.jar - com.sun.xml.stream.buffer
+
 
+
In your <tt>ivy-settings.xml</tt>, add your custom repository in the <tt>resolvers</tt> section, e.g.:
+
<pre>&lt;ibiblio name="ipp-nondistributable"
+
root="/ipp-3rd-party-nondistributable"
+
m2compatible="true" cache="ipp-tools-ivy-cache"/&gt;
+
</pre>
+
In the <tt>chain</tt> section, add a reference to this repository:
+
<pre>&lt;chain name="pull-ipp-deps"&gt;
+
...
+
&lt;resolver ref="ipp-nondistributable" /&gt;
+
...
+
&lt;/chain&gt;
+
</pre>
+
== Upgrading and Downgrading Installed Features  ==
+
 
+
You have the option to upgrade or downgrade installed features. The following sections describe the necessary steps to be performed:<br>
+
 
+
*[[#up|Upgrading Features]]
+
*[[#down|Downgrading to Earlier Versions]]<br>
+
 
+
=== Upgrading Features  ===
+
 
+
To upgrade your installed features to a later version provided in the repository, 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, also take care to perform the necessary steps to upgrade your Web project and model accordingly, as described in chapter [[Upgrading to Later Versions|Upgrading to Later Versions]].  
+
 
+
<br>
+

Revision as of 04:58, 18 June 2015

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 IDE for Java EE Developers

  • Go to Eclipse download page and download Eclipse IDE for Java EE Developers
  • Download and unzip to your hard drive

Install Stardust

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

Install-stardust-3.0.0.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