Running Rhapsody from within Eclipse

Running Rhapsody through the Eclipse development environment allows for easier development and debugging of Rhapsody filters and communication points. Run configurations can either be created manually, or are generated for you when you set up custom filter or communication point projects.

Run Configuration Set-up

Using a New Run Configuration

To create a configuration to run Rhapsody:

1. Ensure you have set up logging in Eclipse. Refer to Configure Logging for details.
2. From Eclipse, navigate to Run>Run Configurations....
3. Right-click on OSGi Framework and select New.
4. In the Bundles tab:
   • Select all bundles under Target Platform except from com.orchestral.rhapsody.modules.dicom and com.orchestral.rhapsody.process.solaris.
5. In the Arguments tab.

   • Replace the contents of the VM arguments field with:

     -Djava.awt.headless=true
     -Dosgi.noShutdown=true
     -Declipse.ignoreApp=true
     -Dosgi.classloader.singleThreadLoads=true
     -Xms256m
     -XX:MaxMetaspaceSize=256m
     -Dorg.osgi.framework.os.name=Win32

   • Set the Working directory to Other. Use the File System button to browse to the directory the Rhapsody engine was installed into (the default location being C:\Program Files\Rhapsody\Rhapsody Engine 6).  
6. In the Settings tab:
   • Ensure that the Runtime JRE is selected as the JRE that is installed with Rhapsody (for example in the <Rhapsody>\JRE directory). If necessary, use the Installed JREs... button to add the Rhapsody JRE, and select it from the dropdown list. It can be important to ensure the correct JRE is used in debugging to ensure the same results in a live environment.
7. Select the Apply button, and then Close.
8. You can now start Rhapsody.

Using a Generated Run Configuration

To use a generated configuration to run Rhapsody:

1. Ensure you have set up logging in Eclipse. Refer to Configure Logging for details.
2. From Eclipse, navigate to Run>Run Configurations....
3. Under OSGi Framework, select Rhapsody.
4. In the Bundles tab:
   • Select all bundles under Target Platform apart from com.orchestral.rhapsody.modules.dicom and com.orchestral.rhapsody.process.solaris.
5. In the Arguments tab:
   • Check that the Working directory is set to the directory the Rhapsody engine was installed into (the default location being C:\Program Files\Rhapsody\Rhapsody Engine 6). If necessary, select Other, and use the File System button to browse to the correct location.
6. In the Settings tab:
   • Ensure that the Runtime JRE is selected as the JRE that is installed with Rhapsody (for example in the <Rhapsody>\JRE directory). If necessary, use the Installed JREs... button to add the Rhapsody JRE, and select it from the dropdown list. It can be important to ensure the correct JRE is used in debugging to ensure the same results in a live environment.
7. Select the Apply button, and then Close.
8. You can now start Rhapsody.

Starting Rhapsody

To start Rhapsody:

1. Ensure that the Rhapsody service is currently stopped.
2. Navigate to Run>Run Configurations..., and click the Run button with the appropriate Rhapsody run configuration selected.
3. Rhapsody should begin to startup through the Eclipse environment.

There is no single log message that indicates that Rhapsody has completed startup. However, when Rhapsody has started, the Management Console and Rhapsody IDE become available.

Stopping Rhapsody

To stop Rhapsody, enter close or exit in the Eclipse console window.

Common Errors

Rhapsody can fail to run if there are:  

Missing Permissions

Log error message: java.io.FileNotFoundException: log\log.txt (Access is denied)
Cause: Eclipse is missing permissions to access files in the Rhapsody installation directory.
Resolution: Run Eclipse as Administrator.

Port Conflicts

Log error message: java.net.BindException: Address already in use: JVM_Bind /0.0.0.0:8444
Cause: The Rhapsody ports are already in use.
Resolution: Stop the Rhapsody instance that is using the same ports.