Getting Started Development Setup Atelier Plug-in for Eclipse

Atelier Plug-in for Eclipse

The Atelier plug-in extends that support to the InterSystems IRIS™ database platform, bringing InterSystems IRIS into the Eclipse ecosystem. When you develop applications with Atelier, you edit and save source files on your client machine. You compile, run, and debug source files on a server instance, using a connection you create and maintain in Atelier.


  • Atelier is able to draw on the powerful debugging capability built into Eclipse.
  • Eclipse plug-ins exist for virtually all widely used version control systems enabling you to use the one of your choice to manage development.
  • The extensive array of plug-ins and extensions available for Eclipse means you can use whatever additional technologies your project requires, all in a single development environment.


In order to try Atelier, you must first download and install Eclipse. Then you can install the Atelier plug-in. The Atelier Download page describes the steps necessary to get up and running with Atelier.

The first time you start Eclipse, it asks you to select a workspace. An Eclipse workspace is just a directory on your local disk where Eclipse stores the resources you use for development. Once you are running the Eclipse application, you have a number of resources available to guide you through your first steps:

  • Cheat Sheets that provide step-by-step guidance through basic Atelier tasks. Select Help > Cheat Sheets… from the main menu, open the Atelier folder, and select a topic of interest. You may want to work through the cheat sheets in the order listed, as each one builds on previously covered material.
  • Product Documentation, which is available by selecting Help > Help Contents from the main menu.
    • Getting Started provides an introduction to Atelier and the Eclipse UI.
    • Concepts introduces the major components and capabilities of Atelier.
    • Tasks contains topics that walk you through a number of useful tasks with Atelier.
    • Reference provides more detailed technical information about Atelier.
You may find it helpful to view the brief video Setting Up Atelier with InterSystems Products before getting started.

Creating a server connection

  1. our first step is to open the Atelier perspective. An Eclipse perspective is a set of UI resources, or views, that help you perform a group of related tasks. In this case, we need the Server Explorer view, which is part of the Atelier perspective.

    To open the Atelier perspective, click on the Open Perspective button, shown in the following screen shot:

    This button opens a dialog, shown in the next screen shot, that lists available perspectives.

    Select Atelier and click Open.

  2. Once you are in the Atelier perspective, click on the tab for the Server Explorer view. The next screen shot shows the Server Explorer view selected, with one existing connection:
  3. You can create a new connection by clicking the green plus sign in the view toolbar. This action opens the Server Connection Configuration wizard:
  4. Now, fill in the fields in the connection wizard with the connection information for your instance from in Connecting an IDE.
    1. Connection Name: Enter a name to identify the new connection. The connection name cannot contain spaces.
    2. Next, fill in Web Server Configuration section.
      1. Address: Enter the DNS name or the IPV4 or IPV6 address of the host on which the instance for this connection is running.
      2. Web Port: Enter the webserver port number used by the server.

        Do not enter the superserver port number at this prompt.
      3. Secure Connection: Leave this box unchecked. In a real-world application, you would want to use a secure connection, but that is not necessary for this quick introduction.
    3. Next, fill in Credentials section:
      1. Username: A valid user ID for the instance specified in the Web Server Configuration section. The user must have the minimum required privileges. See Minimum Required Privileges.
      2. Password: A valid password for the specified user.
    4. Click the Test Connection button to test the connection. You see either “Connection succeeded.” or an error message.
    5. Once the connection test had completed successfully, click the Finish button to create the connection.
The newly created connection is listed in the Server Explorer. You can open the connection node and drill down to examine the resources provided by the connection.

Creating a project

Atelier uses projects to organize your work, so your next step is to create a project.

  1. Right-click in the Atelier Explorer view to open the context menu and select New > Atelier Project, as illustrated:
    This action opens the New Atelier Project wizard:
  2. Next, fill in the fields in the Atelier project wizard:
    1. Enter a name for the project in the Project name field. We will use DemoProject.
    2. Leave the check box Use default location selected, which puts your new project in your current workspace.
    3. Next, fill in the Connection Configuration section:
      1. Server: Use this drop-down list to select the server you configured in the previous section. If you need to create a new server connection at this point, the button labeled Configure server… opens the Server Connection Configuration wizard for you.
      2. Once you have selected a server, use the Namespace drop-down list to select a namespace from those available on the server.
    4. Click Finish to create the project.
  3. You can now see your new project listed in the Atelier Explorer, as shown:

Learn More

InterSystems provides several resources to learn more about Atelier:

  • Atelier Videos — Step-by-step videos that guide you through a number of basic development tasks
  • Atelier Documentation
  • Atelier Group — An online forum in the InterSystems Developer Community where you can connect with other developers, ask questions, and read and contribute articles