docs.intersystems.com
Home

InterSystems IRIS Basics: Connecting an IDE
InterSystems: The power behind what matters   
Search:  


This document tells you how to quickly connect your integrated development environment (IDE) to an instance of InterSystems IRIS and verify that you have successfully connected, using template files downloaded from GitHub.
The instructions cover IDEs in the following categories:
Read the next section, InterSystems IRIS Connection Information, regardless of which IDE you want to connect to InterSystems IRIS.
InterSystems IRIS Connection Information
To connect an IDE to an InterSystems IRIS instance, you first need to select the instance, then determine the needed connection information, as follows:
It is also helpful to know the URL of the instance’s web-based Management Portal.
You can determine this information in the following ways, depending on the type of instance you select, as outlined in the following:
Finally, it is useful to know how to open the InterSystems Terminal (Terminal for short), which provides command-line interaction with an InterSystems IRIS instance. The procedure differs for the three types of instances, as follows:
All instances come with a USER namespace you can use to establish your IDE connection. You can also log into the Management Portal, using the information in the preceding, and create a namespace for this purpose. In the Management Portal and Terminal, you can switch between namespaces at will.
IDEs from InterSystems
This section covers Atelier and Studio.
Atelier
The Atelier plug-in from InterSystems enables you to take advantage of the widely-known Eclipse open-source development environment to develop applications using InterSystems technology. 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. Eclipse also provides plug-ins exist for virtually all widely-used version control systems (VCS) and a powerful built-in debugging capability that is fully exploited by Atelier. The Atelier home page explains how to install Atelier and provides links to other information about Atelier.
The video Setting Up Atelier with InterSystems Products takes you step-by-step through the process of downloading Eclipse, adding the Atelier plug-in, and connecting Atelier to an instance of InterSystems IRIS. The document First Look: Atelier with InterSystems Products also describes the procedures for connecting Atelier to InterSystems IRIS, and includes a hand-on example of using Atelier to create and run a simple class file. It is important to note that Atelier connects using the webserver port (see InterSystems IRIS Connection Information), rather than using the superserver port like other IDEs.
Studio
InterSystems IRIS application developers can also the Studio IDE, a client application running on Windows systems; see Using Studio for detailed information. Studio can connect to any InterSystems IRIS instance regardless of the platform the instance is running on, using the DNS name or IP address of the host, the name of the instance, and the instance’s superserver port number.
Java IDEs
This section provides connection instructions for Eclipse, IntelliJ, and NetBeans.
Eclipse
To connect Eclipse to InterSystems IRIS, use the following steps. (Click Next to advance to the next panel of each dialog as needed.)
First, import the sample package,
  1. Select the master branch, configure local storage, then choose Import existing Eclipse projects.
  2. Confirm the import by clicking Finish.
Next, update the sample code and run it.
    1. Change the package declaration at the top to package main.java.com.intersystems.samples;.
    2. Configure the username, password, IP address, and port for your instance (see InterSystems IRIS Connection Information) in the variable declarations at the top of the main method. These values are used to construct the InterSystems JDBC connection string, in the form jdbc:IRIS://ipAddress:superserverPort/namespace, for example jdbc:IRIS://12.345.678.910:51773/USER.
  1. Run the code by selecting Run > Run.
If you are not successful, confirm that the Java execution environment is set properly by doing the following:
  1. Right-click the samples-java-helloworld project in the Package Explorer pane and choose Build Path > Configure Build Path....
  2. On the Libraries tab, choose Add Library > JRE System Library > Execution environment > and choose an execution environment, such as JRE-1.1 (jre 1.8.0_172). Click Finish and then Apply and Close.
IntelliJ
To connect IntelliJ to InterSystems IRIS, use the following steps. (Click Next to advance to the next panel of each dialog as needed.)
First, create the sample project.
  1. On the Clone Repository dialog,
    1. For the Directory field, enter the path to the location where you want the local GitHub repository created.
  2. Click Clone, then choose Yes in the popup to create a project based on this source.
Next, update the sample code and run it.
  1. Open src/main/java.com.intersystems.samples.helloworld.java and configure the username, password, IP address, and port for your instance (see InterSystems IRIS Connection Information) in the variable declarations at the top of the main method. These values are used to construct the InterSystems JDBC connection string, in the form jdbc:IRIS://ipAddress:superserverPort/namespace, for example jdbc:IRIS://12.345.678.910:51773/USER.
  2. In the Project pane, right-click HelloWorld.java and choose Run ‘HelloWorld.main()’.
If you are not successful, confirm that the Java execution environment is set properly by doing the following:
  1. Edit the configuration and add a new application configuration, selecting com.intersystems.samples.HelloWorld for the main class.
  2. If the error Error:java: invalid source release: 9 is displayed, change the project SDK and project language level to 1.8 in the following locations:
NetBeans
To connect NetBeans to InterSystems IRIS, use the following steps. (Click Next to advance to the next panel of each dialog as needed.)
First, create the sample project.
  1. Select Team > Git > Clone.
  2. Select Master as the branch to be fetched, choose the location where you want the local GitHub repository to be created, and click Finish.
Next, update the sample code and run it.
  1. Open HelloWorld.java and configure the username, password, IP address, and port for your instance (see InterSystems IRIS Connection Information) in the variable declarations at the top of the main method. These values are used to construct the InterSystems JDBC connection string, in the form jdbc:IRIS://ipAddress:superserverPort/namespace, for example jdbc:IRIS://12.345.678.910:51773/USER.
  2. In the Project pane, open the Dependencies folder, then right-click intersystems-jdbc-3.0.0.jar and choose Manually install artifact. Navigate to the folder you recently cloned, select intersystems-jdbc-3.0.0.jar, and click Install Locally.
  3. In the Project pane, right-click HelloWorld.java and choose Run File.
.NET IDEs
This section provides connection instructions for Microsoft’s Visual Studio and Visual Studio Code.
Visual Studio
To connect Visual Studio to InterSystems IRIS, use the following steps. (Log into GitHub if necessary.)
First, create the sample solution.
  1. In the Team Explorer – Connect pane, select Local Git Repositories > Clone, copy and paste https://github.com/intersystems/Samples-dotnet-helloworld into the URL box, and click Clone.
Next, update the sample code and run it.
  1. Double-click HelloWorld.sln to see the files in the solution, then open helloworld.cs.
  2. Configure the username, password, IP address, and port for your instance (see InterSystems IRIS Connection Information) using the variable declarations,
  3. Press the F5 key to run the program.
Visual Studio Code
To connect Visual Studio to InterSystems IRIS, use the following steps. (Log into GitHub if necessary.)
  1. In your web browser, download or clone https://github.com/intersystems/Samples-dotnet-helloworld.
  2. In Visual Studio Code, use File > Open Folder to open the folder you recently downloaded or cloned from GitHub.
  3. Configure the username, password, IP address, and port for your instance (see InterSystems IRIS Connection Information) using the variable declarations.
  4. Use View > Terminal to open the terminal and execute the following commands:
    csc /reference:InterSystems.Data.IRISClient.dll helloworld.cs
    .\helloworld.exe


View this article as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-04-10 14:45:55