3 Installing Prerequisite Software

This chapter describes the software that you are required to install before installing Design Studio.

About Installing Prerequisite Software

Before installing Design Studio, do the following:

Note:

The following setup instructions are intended for system administrators. Individual Design Studio users should contact an administrator for instructions on obtaining and installing a preconfigured archive file.

  1. Install Eclipse.

    See "Installing Eclipse" for more information.

  2. Download the Java SE JDK.

    Download the Java 21 version that matches the Eclipse version. For example, a 64-bit Eclipse version requires a 64-bit Java version.

    Download the latest update of JDK 21 for the required platform from the Oracle Technology Network Web site:

    http://www.oracle.com/technetwork/java/javase/downloads/index.html

  3. Install the Java SE JDK.

    For information about installing the JDK, see the JDK installation documentation:

    http://docs.oracle.com/javase/21/docs/technotes/guides/install/install_overview.html

  4. Configure the Eclipse startup properties.

    See "Configuring Eclipse Startup Properties" for more information.

  5. Verify the Eclipse installation.

    See "Verifying Design Studio Feature Installation" for more information.

  6. Locate the Oracle WebLogic Server installation directory.

    The Design Studio installation script requires you to define the MIDDLEWARE_HOME variable (for example, C:\Oracle\Middleware) and the WEBLOGIC_HOME variable (for example, C:\Oracle\Middleware\wlserver). Additionally, Order and Service Management users require access to Oracle WebLogic Server libraries when building cartridge projects in Design Studio.

    When defining these variables, you can point to an existing installation, or you can copy the libraries required by Design Studio and include those directories in your local Design Studio installation. If copying, copy all of the files and folders in the Oracle Fusion Middleware home directory (for example, C:\Oracle\Middleware), and paste those files into a local Fusion Middleware home directory (such as C:\Oracle\Middleware).

    See the OSM Installation Guide for information about which version of Oracle WebLogic Server you require. The OSM Installation Guide is available on the Oracle Help Center:

    http://docs.oracle.com/en/industries/communications/order-service-management/index.html

    See the Oracle Fusion Middleware page on Oracle Help Center for information about installing Oracle WebLogic Server:

    https://docs.oracle.com/en/middleware/fusion-middleware/index.html

    Note:

    Do not install an Oracle WebLogic Server domain specifically for Design Studio.

  7. Do one of the following:

Installing Eclipse

To download and install Eclipse:

  1. Download the Eclipse IDE 2024-09 for Enterprise Java and Web Developers from the Eclipse website:

    https://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/2024-09/R/eclipse-jee-2024-09-R-win32-x86_64.zip

  2. Read and accept the license agreement, then select the Windows (64-bit) link.

    Note:

    Oracle Mobile Application Framework (MAF) supports application development for iOS and Android. Design Studio does not require MAF. Select the MAF bundle only if you require iOS and Android application development support in your Eclipse installation.

  3. Download the archive file to an installation location and unzip the file.

    For example, unzip the file into a new directory called DesignStudio. In this guide, subsequent references to this directory refer to this location as Eclipse_Home.

Configuring Eclipse Startup Properties

System administrators control Eclipse startup by configuring properties in the eclipse.ini file, located in the Eclipse root directory. By editing eclipse.ini, system administrators can:

  • Define the initial amount of memory for the Java heap size.

    A heap is the common pool of free memory available to a program. If Eclipse is using more memory than is available, increase the heap size allocated by the JVM to Eclipse. Increasing the heap size may eliminate OutOfMemoryError instances when Eclipse attempts to instantiate objects.

    To define the initial amount of memory the JVM allocates to Eclipse, use the -Xms setting.

  • Define the maximum amount of memory for the Java heap size.

    To define the maximum amount of memory that the JVM can allocate to Eclipse, use the -Xmx setting. Consider the following guidelines:

    • For individual users working on a 64-bit version of Eclipse on Windows (64-bit), you can define the maximum memory values higher than 1024 MB, enabling full use of available memory. For example, if an individual Design Studio user runs Eclipse on a 4 GB machine running Windows (64-bit), you can define the -Xmx option up to -Xmx3096m.

    • If out-of-memory errors occur at startup (because of an increase to the maximum allocated heap that the operating system is unable to support), close Design Studio, reduce the -Xmx value, and reopen Design Studio. Oracle recommends reducing the value gradually to ensure that Design Studio starts with the greatest heap space possible.

To use Oracle Java SE with Eclipse, a system administrator configures the eclipse.ini file settings with -vm option as shown in the following example: 

-vm
C:/Java21/bin

In the following example, a system administrator configures the eclipse.ini file settings for machines with at least 4 GB of memory: 

-startup
plugins/org.eclipse.equinox.launcher_1.6.900.v20240613-2009.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.2.1100.v20240722-2106
-product
com.mslv.studio.branding.Studio
-showsplash
platform:/base/plugins/com.mslv.studio.branding
--launcher.defaultAction
openFile
--launcher.appendVmargs
-vm
C:/Java21/bin
-vmargs    
-Dorg.eclipse.ecf.provider.filetransfer.excludeContributors=org.eclipse.ecf.provider.filetransfer.httpclientjava
-Dosgi.requiredJavaVersion=21
-Dosgi.instance.area.default=@user.home/eclipse-workspace
-Dosgi.dataAreaRequiresExplicitInit=true
-Dorg.eclipse.swt.graphics.Resource.reportNonDisposed=true
-Declipse.e4.inject.javax.warning=false
-Dsun.java.command=Eclipse
-Xms256m
-Xmx2048m
-XX:+UseG1GC
-XX:+UseStringDeduplication
--add-modules=ALL-SYSTEM
--add-exports=java.base/sun.security.action=ALL-UNNAMED
--add-opens=java.base/java.io=ALL-UNNAMED
--add-modules=java.naming
-Djava.security.manager=allow

For more information about the eclipse.ini file, see:

http://wiki.eclipse.org/Eclipse.ini

Verifying the Eclipse Installation

To verify that the Eclipse platform installed successfully:

  1. Double-click the eclipse.exe file.

    The Workspace Launcher dialog box appears.

  2. Specify a workspace.

    You can select a temporary folder or accept the default location. However, each individual Design Studio user should identify the appropriate working directory on their local machine. To help Design Studio users identify in which directory configuration information should be stored on their computer, system administrators can specify in the Workspace Launcher dialog box a location where most users will want to place their configuration files. The directory and folder structure that the installation administrator specifies in this step will become the default value for the Workspace field in the Workspace Launcher.

  3. Click OK.

    The Welcome screen appears.

  4. Select Help, then About Eclipse Platform.

  5. Verify the Eclipse version.

Installing the Business Intelligence, Reporting, and Charting Feature

You install the Business Intelligence, Reporting, and Charting feature (BIRT) to develop report designs and generate reports that Design Studio users can use to review detailed information about an implemented solution. For example, you can design reports that capture the name, type, description, and relationships of projects, entities, and data elements. Design Studio users can generate these reports and share solution modeling information among team members.

Note:

This procedure requires internet access. You can install BIRT offline using the Design Studio installation build.properties file.

See "Downloading Prerequisite Features for Offline Installation" for information about installing BIRT offline.

To install the Business Intelligence, Reporting, and Charting feature:

  1. In the Eclipse application, from the Help menu, select Install New Software.

    The Available Software dialog box appears.

  2. In the Work with field, click the menu and select the following update site:

    2024-09 - https://download.eclipse.org/birt/updates/release/latest/

    A list of features available from the site appears.

  3. Select Business Intelligence, Reporting and Charting (BIRT Framework).

  4. Click Next.

    The Install Details dialog box appears.

  5. Review the installation details.

  6. Click Next.

    The Review Licenses dialog box appears.

  7. Review and accept the license agreement.

  8. Click Finish.

  9. When prompted, click Yes to restart Eclipse.

Installing the Graphical Editing Framework Zest Visualization Toolkit Feature

The Graphical Editing Framework Zest Visualization Toolkit feature is not included in Eclipse. This feature is a prerequisite that you must install before you install Design Studio.

Note:

The following procedure requires internet access. You can install this feature offline using the Design Studio installation build.properties file.

See "Downloading Prerequisite Features for Offline Installation" for more information.

  1. Open the Eclipse application.

  2. From the Help menu, select Install New Software.

    The Install dialog box appears.

  3. In the Work with field, enter the following:

    https://download.eclipse.org/releases/2024-09

  4. Press the Enter key.

  5. Expand GEF (Graphical Editing Framework) and select Zest Classic SDK.

  6. Click Next and accept the terms of the license agreement.

  7. Click Finish.

  8. Restart Eclipse.

Installing the XSD - XML Schema Definition SDK Feature

The XSD - XML Schema Definition SDK feature is not included in Eclipse. This SDK feature is a prerequisite and you must install it before you install Design Studio.

Note:

The following procedure requires internet access. You can install this feature offline using the Design Studio installation build.properties file.

See "Downloading Prerequisite Features for Offline Installation" for more information.

To install XSD - XML Schema Definition SDK Feature:

  1. Open the Eclipse application.

  2. From the Help menu, select Install New Software.

    The Install dialog box appears.

  3. In the Work with field, enter the following:

    https://download.eclipse.org/releases/2024-09

  4. Press the Enter key.

  5. Type XSD and select XSD - XML Schema Definition SDK.

  6. Click Next and accept the terms of the license agreement.

  7. Click Finish.

  8. Restart Eclipse.

Downloading Prerequisite Features for Offline Installation

The XSD - XML Schema Definition SDK feature, the Graphical Editing Framework Zest Visualization Toolkit feature, and the Business Intelligence, Reporting, and Charting feature are not included in Eclipse. These features are prerequisites that you must install them before you install Design Studio.

If you do not have internet access during installation, you can download these features and install them later when you are offline.

To download the prerequisite features for offline installation:

  1. Download the Business Intelligence, Reporting, and Charting feature and by using the following URL:

    https://www.eclipse.org/downloads/download.php?file=/birt/updates/release/4.18.0/BIRT-Updates-4.18.0.zip

  2. Save BIRT-Updates-4.18.0.zip to a shared location and extract the file.

  3. Download the Graphical Editing Framework Zest Visualization Toolkit feature using the following URL:

    https://www.eclipse.org/downloads/download.php?file=/tools/gef/classic/release/3.21.0/GEF-Updates-3.21.0.zip

  4. Save GEF-Updates-3.21.0.zip to a shared location and extract the file.

  5. Download the XSD - XML Schema Definition SDK feature.

    https://www.eclipse.org/downloads/download.php?file=/modeling/emf/emf/builds/release/2.39.0/EMF-Updates-2.39.0.zip

  6. Save EMF-Updates-2.39.0.zip to a shared location and extract the file.

  7. Install the features offline using the Design Studio installation scripts.

    You can specify the shared location of the extracted GEF-Updates-3.21.0.zip, BIRT-Updates-4.18.0.zip, EMF-Updates-2.39.0.zip files in the Design Studio installation build.properties file.

    See "Installing and Configuring Design Studio" for more information about updating the build.properties file and running the installation script.