NexJ Logo

Setting up NexJ Studio

Before you can use NexJ Studio to develop applications or set deployment information, you need to install NexJ Studio and set required preferences.

NexJ Studio is installed using a configured NexJ Studio installer. For more information on how to configure the NexJ Studio installer, see Configuring the NexJ Studio installer.

Installing NexJ Studio

Before installing NexJ Studio, ensure that you have Java Runtime Environment 7 (JRE 7) with Java Web Start.

To install NexJ Studio:

  1. Open your Internet browser and go to the location for installing NexJ Studio provided to you by the system administrator, for example or file://server-name/installer/studio_install.jnlp.
  2. In the confirmation dialog that appears, confirm that you want to run NexJ Studio Installer on your machine.
    The Installer dialog opens.
  3. To begin installing NexJ Studio, click Next.
  4. In the Version field, select the product version recommended by your system administrator. The Detail section provides information on the install version and bitness. Click Next.
  5. In the Install Location field, the default install location will be filled in. To change the install directory, click the Browse button. In the Browse for Folder dialog that opens, select the directory where you want to install NexJ Studio and click OK.


    If an instance of NexJ Studio is already installed in the selected location, it will be replaced. A warning appears informing you that the chosen directory is not empty.

  6. In the Install Type field, select the installation layout recommended by your system administrator:
    Stand-alone install
    Stores this installation of NexJ Studio in its own directory.
    Shared install
    Shares the directory between different versions of NexJ Studio and other Eclipse-based products. If you choose Shared install, specify the shared directory in the Select shared directory field.
    Click Next.

  7. The location of the JVM file should be automatically filled in. If the installer is launched using 32-bit JRE, then the file path appears blank and you must locate the 64-bit JVM file location. To specify the JVM folder location, click Browse. In the Browse for Folder dialog that opens, select the directory where the appropriate JVM is located and click OK. Click Next.


    The default JVM location is JVM_install_location/jreVersion_number/bin folder where JVM_install_location is the JVM install folder and Version_number is the version installed on your machine. If you do not select the correct folder, you will not be able to continue.

  8. After the configuration is complete, read and accept the Software License and Maintenance Agreement, and then click Install.
    The installation begins.

  9. When the installation is complete, specify whether to launch NexJ Studio immediately.

    • To launch NexJ Studio after installing, ensure that the Run NexJ Studio checkbox is selected and click Finish. The NexJ Studio Installer dialog closes and NexJ Studio opens.


      If you have not set the default workspace folder to store the project files for the current session, the Workspace Launcher dialog opens instead. See Setting the workspace folder for NexJ Studio.

    • To close the NexJ Studio Installer dialog without launching NexJ Studio, ensure that the Run NexJ Studio checkbox is not selected and click Finish. The NexJ Studio Installer dialog closes.

NexJ Studio is successfully installed.

To uninstall NexJ Studio, delete the install directory, which you specified in the Install Location field.

Setting the workspace folder for NexJ Studio

NexJ Studio requires a workspace folder for storing the project files before it can be used.

When you open NexJ Studio for the first time, the Workspace Launcher dialog opens.

To specify the workspace folder for the current session:

  1. Click Browse and select the workspace directory where all the files for NexJ Studio will be located.
    The workspace folder is typically called ws and placed in a C:\work folder.


    To skip this step every time you open NexJ Studio and use the selected workspace as the default workspace, select the Use this as the default and do not ask again checkbox.

  2. Click OK.
    The NexJ Studio application launches.

Configuring NexJ Studio preferences

Before you begin working in NexJ Studio, you must define the location of your build output directory.

The build output directory will store your published models and deployment information.

To configure NexJ Studio preferences:

  1. Click Window → Preferences.
    The Preferences dialog opens.
  2. In the preferences navigation, click NexJ Studio → Build Settings.
    The Build Settings page opens.
  3. In the Build output folder field, click Browse.
    A browse dialog opens.
  4. In the browse dialog, specify the folder that you want to use as your build output folder. This folder is typically named out and placed in a C:\work folder. If the folder does not exist, you can create it by clicking Make New Folder.


    Ensure that the output folder is separate from your workspace folder. Keeping the output folder separate from the workspace folder ensures that loops do not occur.

  5. Click OK.
    The browse dialog closes.

  6. Click OK.
    The Preferences dialog closes.

The build output folder is specified.

To continue with the NexJ CRM deployment process, you can now define environment files. If you are using NexJ Studio to develop new applications, you can now proceed by importing base models and creating new models.

NexJ Studio tour

NexJ Studio provides a set of tools used to manage your models.

NexJ Studio tour

The above figure shows the main window for NexJ Studio. You can rearrange the views and editors in any way that suits your needs. If you want to reset NexJ Studio back to its default settings, select the Window → Perspective → Reset Perspective menu options.

  1. The Model Navigator is located in the left-hand side of the window.
    • All the model entries are accessible here and are arranged into functional layers.
    • Items from the base model can be customized by selecting one and using the Customize right mouse button menu item.
    • The name of the currently open model is displayed at the top of the navigator.
    • If you are managing more than one model, you can switch between models using the View Menu button at the top of the navigator.
    • You can hide or show all non-customized items from the base model. Click the View Menu button and select Hide Base Elements.
    • You can also switch to a hierarchy view of the resources by clicking the Show Hierarchy button .
  2. Editors are launched in the center of the screen when they are opened, typically from the model navigator.
    • Each of the model elements has a specialized editor. For example, a class diagram editor is provided for class diagrams and a message editor is provided for messages.
    • Help on the currently selected item in an editor automatically displays in the status bar in the bottom left corner of the screen. Shift+F2 shows more help, if available.
  3. The Console view is where console output is displayed when testing your model with the Server Console or using other tools.
  4. The Properties List view shows the properties of the currently selected item in the active editor.
  5. The Outline view shows a tree of all the parts of the current item being edited and can be used for navigation and editing.
  6. The toolbar provides quick access to tools for NexJ Studio.

The model navigator for NexJ Studio organizes the components of your model into architectural layers.

Model client user interfaces, including reporting.

Business Model
Model your business including business concepts in classes, class relationships, business logic, and workflows. This layer also includes BI models for analytics and reporting.

Model system permissions.


Model physical storage including data sources, upgrades, data extracts (dumps), and ETL activities.

Model communication with external systems including messages, transformations, services, channels, diagrams, SOA definitions and implementations, and interfaces.

Maintain common framework capabilities such as localization, translation, and common code libraries.

Manage your deployment environments for servers and connections, including staging, user acceptance, performance, and production.

Running the Minimal Scheme Console

Use the Minimal Scheme Console to run Scheme scripts and test your model.

NexJ Studio uses Scheme as its scripting and business logic programming language. Use Scheme to check your model's behavior, gather information about the data store, define unit tests, and define aspects of your model's behavior.

To run the Minimal Scheme Console:

  1. In the NexJ Studio toolbar, click the down arrow next to the Run Scheme Console button and select Minimal Console.
    The Console view opens.


    Once the console is ready for input, the following prompt appears at the bottom of the console:

    ; NexJ Scheme
  2. In the Console view, enter your script and press Enter to execute it.

  3. Confirm that the script has successfully run without errors.

Using the web-based Scheme Console

If you do not have access to NexJ Studio, you can use the web-based Scheme Console to evaluate Scheme scripts.

The web-based Scheme Console can be accessed separately from the following URL:


This console is not directly accessible from NexJ CRM, NexJ Admin Console, or NexJ System Admin Console.

This console is not directly accessible from NexJ CRM, NexJ Admin Console, or NexJ System Admin Console.

Administrators with AdminSchemeExecute privileges can access the console.

In the web-based Scheme Console, enter your script in the Scheme Expression field and click Evaluate Expression. Results display in the Return Value field.

The web-based Scheme Console also logs all requests, results, and execution times. You can access these logs from NexJ Admin Console by navigating to the Audit Trail page. All requests are logged in the application log at the INFO level of logging information.