Getting Started with InterSystems IRIS Community Edition
Want to see what InterSystems IRIS™ can do? One fast and easy way is to get an InterSystems IRIS Community Edition instance, which comes with a free license. You can provision a public cloud node hosting a containerized instance or download an image from the Docker Store and deploy your own container. This document explains how to get your cloud node or container image, and how to interact with your InterSystems IRIS instance.
To get started,
Log into your Google Public Cloud, Amazon Web Services, or Microsoft Azure account. If neither you nor your employer have one yet, you can go to the GCP
, or Azure
portal page to quickly create a free account. Select or create a project (GCP), an IAM user and credentials (AWS), or a resource group (Azure).
Find the InterSystems IRIS Community Edition page for your cloud provider by going to the Get InterSystems IRIS Today!
page and selecting the appropriate link. (You can also go to the cloud provider’s marketplace page and search for InterSystems IRIS
.) Get InterSystems IRIS Today! also includes links to short video tutorials on getting started with a cloud node.
That’s it! You are the proud owner of an InterSystems IRIS Community Edition instance on a cloud node. The instance comes with a free built-in 13-month license (there are some functionality restrictions
You can also deploy a containerized instance of InterSystems IRIS Community Edition on your own public cloud, private cloud, or hardware system by downloading the Docker container image from the Docker Store’s InterSystems IRIS Data Platform page
. To do this,
Ensure that Docker is installed on your system. (Docker images from InterSystems comply with the OCI support specification, and are supported on Docker Enterprise Edition and Community Edition, version 18.03 and later. Docker EE only is supported for production environments.)
Click the Setup Instructions
button on the Docker Store page to display instructions for pulling the image and running the container.
At your system’s shell prompt, follow the instructions displayed. Make a note of the host ports to which you publish the InterSystems IRIS instance’s superserver and web server ports. For example, the instructions contain the following options:
--publish 52773:52773 \
--publish 51773:51773 \
These options publish the instance’s superserver port and web server port as 51773 and 52773 on the host, respectively.
Execute the docker ps -a
command to see the status of the container, which is called try-iris
, and ensure that it is running.
Before you do anything else, you must secure your InterSystems IRIS instance by changing the default password. To do this on a cloud node, you need to open a shell on the node by securely connecting to it using SSH.
The GCP and Azure interfaces include a built-in SSH connection option (Azure uses the credentials you provided when deploying the node). On AWS, and as an alternative on the others, you can connect using a separate program such as PuTTY. The cloud portals provide help on connecting with SSH using both the built-in options and third-party programs; for instructions for using PuTTY to connect to an AWS node, see Connecting to AWS Using PuTTY
At the shell prompt on a cloud node, change the default instance password by issuing the command iris password
. Note the predefined user accounts
that are displayed; you will use one of these with the new password you just entered to log into the InterSystems IRIS instance.
At the shell prompt on a cloud node only, you can
Use the special iris
displays the status of the InterSystems IRIS instance.
shows information about connecting to the instance.
loads data into the instance from a specified github repo.
lists these InterSystems IRIS commands.
At the shell prompt on any system hosting the InterSystems IRIS container, cloud node or otherwise, you can
See how containerization makes upgrades a snap by exploring the instance-specific data
stored outside the InterSystems IRIS container.
On the system hosting the container you ran from the downloaded image, it is on the volume you specified with the --volume
option, in the directory you specified in the ISC_DATA_DIRECTORY environment variable. For example, suppose your docker run
command included these options:
--volume /home/pmartinez/iris:/external \
--env ISC_DATA_DIRECTORY=/external/dur \
Issue Docker commands, including the following docker exec
command to open a shell within the InterSystems IRIS container, which is called try-iris
. (The -i
option makes the command interactive and -t
allocates a text terminal.)
docker exec -it try-iris bash
Using the container command line you can interact directly with the containerized InterSystems IRIS instance, as described in the next section, and also explore the instance’s installation directory structure.
All Docker commands issued in the cloud node shell must be prefixed with sudo
Open a shell within the container using the docker exec
command described in the previous section), then execute the iris
command to connect to and manage the InterSystems IRIS instance. For example, to open a Terminal session for the instance (which is called IRIS
), issue the command iris terminal iris
. You can also do this directly from the container host’s shell with the command docker exec -it try-iris iris terminal IRIS
When your Terminal session begins, log in using _SYSTEM
or one of the other predefined accounts
and the new password you provided when changing the password. (If the instance is running on any system other than a cloud node, use the default password SYS
; you are immediately prompted to change it.) You can also open the InterSystems IRIS SQL Shell
by logging in as sqluser
To open the InterSystems IRIS Management Portal for your instance, load this URL in your browser.
When the portal opens, log in using _SYSTEM
or one of the other predefined accounts
and the new password you provided when changing the password. If the instance is not running on a cloud node, or it is on a cloud node but you have not yet changed the default password
, use the default password SYS
; you are immediately prompted to change it.)
The Management Portal
is the comprehensive web-based user interface to an InterSystems IRIS instance. Load it in your browser to configure and manage the instance and to access the InterSystems IRIS data platform features you are interested in. For example, you can create a custom namespace and database
, create resources, roles, and users for authorization
and manage other InterSystems IRIS security and encryption
features, and configure connectivity, national language support
, and other settings. You can also explore the pages used to create and manage interoperability productions
, and use the System Explorer
page to examine tables, views, and stored procedures on the instance, execute SQL queries and review query plans, and review the code on the instance and the globals that provide direct programmatic access to its data.
You can also search the documentation
from the Management Portal, allowing you to review everything InterSystems IRIS has to offer on a topic of interest to you.
To connect an IDE to the InterSystems IRIS instance, you’ll need some or all of the following information:
The hostname or external IP address of the container’s host (as in the Management Portal link).
The instance’s superserver port, 51773, and web server port, 52773. (If you published different host ports for these InterSystems IRIS ports when you started the container, you need to use those host ports instead.)
Credentials for the instance either _SYSTEM
or one of the other predefined accounts
and the new password you provided when changing the password, or a user account you created using the Management Portal.
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.
InterSystems IRIS application developers can also the Studio
IDE, a client application running on Windows systems. Studio can connect to any InterSystems IRIS instance regardless of the platform the istance is running on.
To load data onto the InterSystems IRIS instance using JDBC
, use this connection string:
When you use InterSystems IRIS JDBC to connect to a local Windows machine, the connection automatically uses a special, high-performance local connection, called a shared memory connection
InterSystems IRIS provides two different but complementary ways to access InterSystems databases from a .NET application:
The ADO.NET Managed Provider is the InterSystems implementation of the ADO.NET data access interface, which provides easy relational access to data using the standard ADO.NET Managed Provider classes.
The Entity Framework Provider is the InterSystems implementation of the object-relational mapping (ORM) framework for ADO.NET, enabling .NET developers to work with relational data using domain-specific objects.
Where to go from here? Take your choice of a wide range of destinations. And remember, you can always contact us
for information about or help with InterSystems products, including InterSystems IRIS.
InterSystems IRIS data platform is supported by an extensive set of learning materials.
An Introduction to InterSystems IRIS
These short documents introduce you to an InterSystems feature or technology and give you the chance to try it for yourself on your InterSystems IRIS cloud instance. For example, you can try the hands-on exercises in these First Looks:
With InterSystems Learning Services QuickStarts
, you can see how InterSystems IRIS data platform can be used to improve your systems and benefit your applications, and access informative hands-on encounters with InterSystems technology. You can also consult a wide range of other online learning
On the InterSystems Developer Community
, you can read about and discuss InterSystems products and technologies, including InterSystems IRIS. Posts include articles, questions and answers, announcements, new feature descriptions, and videos. Both InterSystems employees and community members participate. Register on the Developer Community to ask questions about InterSystems IRIS functionality and architecture and get answers from the people who know!
The Worldwide Response Center (WRC)
provides expert technical assistance with InterSystems products. The center is on call 24x7x365 with staff fluent in 15 languages.
You can also get immediate access to a free InterSystems IRIS Community Edition instance (with a few modifications) on the InterSystems Learning Labs web page
, and use it to build an application with one of the many supported languages. Your InterSystems Labs instance comes with an integrated IDE, and several projects with sample data and step-by-step instructions. You can also connect your own IDE to the instance and use that to work with the sample data, or create data of your own that more closely reflects the specific needs of your application. The InterSystems Labs instance comes with a free built-in 90-day license, with functionality limitations
similar to those of the Community Edition cloud instance and Docker Store image.
The InterSystems IRIS instance on the Community Edition cloud node is subject to certain limitations, as follows:
As part of launching a node on AWS, you must designate or create an AWS public-private key pair for use in connecting to it. When you connect using SSH, you must supply the program you are using with the private key from this pair, as downloaded when you created the key pair or as supplied to you by your security administrator. Connect using PuTTY with these steps:
Open the PuTTYgen key generator program that is installed with PuTTY and do the following:
Use the Load
button to load the .pem
private key file provided by AWS. (Remember to set the file type selector in the file browser dialog to All files (*.*)
to display the .pem
file you want to load.)
Open the PuTTY program itself and do the following:
Once you have successfully connected, you can save the connection settings in PuTTY so that fewer steps will be required to connect in the future.
Content Date/Time: 2019-07-17 06:06:46