PDF Index

• Release Information

  New features, changes, and supported platforms

  • Release Notes (GCRN.pdf)

    New features in InterSystems IRIS 2025.1; topics to consider upon upgrading from previous versions

  • Supported Platforms (ISP.pdf)

    Lists the platforms supported by this release.

  • Releases and Prerelease Software

  • Licensing

  • Downloading Samples (ASAMPLES.pdf)

    Describes how to download samples for use with InterSystems products, as well as how to create a namespace and database to hold the samples.

• Deployment

  Options for deploying InterSystems products and your applications

  • Containers

    Deploy InterSystems products and your applications in containers

    • Container How-to (AFL_CONTAINERS.pdf)

      Provides a basic procedure for running an InterSystems IRIS container.

    • Deploy Right Now (ACLOUD.pdf)

      Explains how to deploy, connect to, and use an InterSystems IRIS container, in a public cloud or on your own system.

    • Running in Containers (ADOCK.pdf)

      Describes how to deploy and run InterSystems products in containers

    • Deploying with Kubernetes

      Deploy InterSystems IRIS topologies and your application on Kubernetes platforms

  • Installation Kit

    Install an instance anywhere with an installation kit

    • Install on Windows (GIWIN.pdf)

    • Install on UNIX, Linux, and macOS (GIUNIX.pdf)

    • Installation Details

      • All Platforms (GIEMISC.pdf)

      • Windows (GIEWIN.pdf)

      • UNIX®, Linux, and macOS (GIEUNIX.pdf)

    • Upgrade Procedure (GCI.pdf)

      Describes the process of upgrading or modifying an instance on your system.

    • Upgrade Reference (GUPE.pdf)

      Describes details for Upgrading.

  • Configuration

    Deploy complex InterSystems IRIS topologies out of the box

    • Resource Planning (ARES.pdf)

      This document describes resource considerations for your deployment.

    • Automating Configuration (GCMF.pdf)

      Explains how to use configuration merge with InterSystems IRIS

    • Configuration Parameters (CPF) (RACS.pdf)

      Describes the purpose and syntax of entries in the Configuration Parameter File.

  • Data Migration

    InterSystems IRIS tools for migrating your data and stored procedures from other database systems

    • Server Migration (AMIG.pdf)

      Provides guidelines on migrating an instance and its related data from one server to another.

    • ISQL Migration (GISQ.pdf)

      Describes the InterSystems implementation of ISQL and how to migrate schemas and stored procedures from Informix.

    • TSQL Migration (GTSQ.pdf)

      Describes the InterSystems implementation of TSQL and how to migrate schemas and stored procedures from Sybase or SQL Server.

    • DataMove (ADM.pdf)

      Describes how to move data associated with an InterSystems IRIS namespace to a different database.

  • Adding Compiled Code (ADEPLOY.pdf)

    Describes how to add compiled, deployed code to customer databases.

• Administration

  Administering your data platform to maintain effective and efficient support for your application

  • System Administration (GSA.pdf)

    Introduces common system administration tasks.

  • Monitoring

    Monitoring the health and performance of your application and data platform

    • Monitoring Guide (GCM.pdf)

      Describes the tools, routines, and third-party interfaces available to monitor InterSystems products.

    • Emit OpenTelemetry Signals (AOTEL.pdf)

      Describes how to configure InterSystems IRIS to emit metric, log, and trace data as OpenTelemetry Protocol signals over HTTP

    • Error Reference (RERR.pdf)

      Lists error codes associated with general operations, SQL, the database engine, and productions.

  • Operations (GOPS.pdf)

    Describes day-to-day operations and monitoring recommendations for InterSystems IRIS systems.

  • Install Code from WRC (AWRC.pdf)

  • Special Tools & Utilities (GSTU.pdf)

    Describes tools and utilities for managing and extending InterSystems-based systems.

• Architecture

  Building the right data platform for your application

  • Mirroring and High Availability

    High availability for 24/7 application access

    • High Availability Solutions (ADCHA.pdf)

      Discusses several general strategies for achieving high availability with InterSystems-based applications.

    • Data Resiliency (AFL_DATARESIL.pdf)

      Introduces the crash recovery, high availability, and disaster recovery capabilities of InterSystems products.

    • High Availability Guide (GHA.pdf)

      Explains the many mechanisms provided by InterSystems products to maintain highly available and reliable systems.

  • Scalability

    Scale your platform to get the best performance for your workload

    • Basics: Distributed Caching (AFL_ECP.pdf)

      Introduces the use of distributed caching enabled by ECP to scale for user volume.

    • Demo: Sharding (AFL_SHARDING.pdf)

      Introduces sharding and how it can be used to scale InterSystems-based applications for data volume.

    • Scalability Guide (GSCALE.pdf)

      Explains how to scale InterSystems products to meet the demands of your workload.

  • Resiliency & Data Integrity (GCDI.pdf)

    Explains the mechanisms used in InterSystems products to maintain data integrity.

• Security

  InterSystems IRIS security features include authentication, authorization, LDAP support, TLS support, SQL security, encryption, hardening instance security, auditing, and PKI tools.

  • Security Strategy (ASECURING.pdf)

    Plan and maintain a secure InterSystems IRIS® instance

  • IRISSECURITY (ASECURITYDB.pdf)

    IRISSECURITY is the storage location for security data.

  • Using Security APIs (ASECURITYAPI.pdf)

    IRISSECURITY is the storage location for security data.

  • Auditing (AAUDIT.pdf)

    Auditing allows you to monitor events that occur within InterSystems IRIS, or in an application, and add entries to a secure audit database when these events occur.

  • Authentication (AAUTHN.pdf)

    The fundamentals of InterSystems IRIS® authentication and its supported authentication systems

  • Authorization (AAUTHZ.pdf)

  • Encryption (AENCRYPT.pdf)

    InterSystems IRIS encryption includes database encryption, data-element encryption, and key management.

  • TLS (ATLS.pdf)

  • Security Reference (ROARS.pdf)

• Developer Tools

  • ObjectScript Shell (GCLI.pdf)

    Describes how to use the ObjectScript shell.

  • Windows Terminal (GTER.pdf)

    Describes how to use the Windows Terminal application, which provides a command-line interface for ObjectScript.

  • Connecting an IDE (AB_IDESETUP.pdf)

    Explains how to connect an Integrated Development Environment (IDE) to an InterSystems IRIS instance and test the connection using prepared code.

  • Source Control Integration (ASC.pdf)

    Describes how to integrate InterSystems IRIS with an external source control system.

  • Classes Page (ACLS.pdf)

    Describes how to manage classes via the Management Portal.

  • Routines Page (AROU.pdf)

    Describes how to manage routines via the Management Portal.

  • Class Reference (ACLASSREF.pdf)

    Describes how to locate and explore your local class reference documentation.

  • Unit Testing with %UnitTest (GUNITTEST.pdf)

    Describes how to develop and execute unit tests using the classes included in the %UnitTest package.

  • Scanning for Deprecated Code (ACODESCAN.pdf)

    Describes how to scan a namespace to find uses of code that has been deprecated.

• Embedded Language Development

  Developing applications using languages embedded in the InterSystems IRIS kernel

  • Multiple Data Models

    A single, integrated data dictionary that can be accessed using one of several data models

  • Orientation for Programmers (GORIENT.pdf)

    Presents the essentials for programmers who write server-side code using InterSystems products.

  • Developing Applications (GAPPS.pdf)

    Provides an overview of and details about creating modern applications with Python, SQL and ObjectScript.

  • ObjectScript

    Write ObjectScript code in class definitions or routines

    • Using ObjectScript (GCOS.pdf)

      Provides an overview of and details about the ObjectScript programming language.

    • ObjectScript Reference (RCOS.pdf)

      Provides reference material for ObjectScript.

    • ObjectScript Tutorial (TOS.pdf)

      Provides an interactive introduction to the ObjectScript language.

  • Embedded Python

    • Intro to Embedded Python (AFL_EPYTHON.pdf)

      Introduces Embedded Python and illustrates some of the ways it can be used.

    • Using Embedded Python (GEPYTHON.pdf)

      Discusses more advanced Embedded Python topics with tips on how to use Python for programming InterSystems IRIS applications.

  • Multidimensional Storage (GGBL.pdf)

    Describes the InterSystems multidimensional storage mechanism and how to work with it.

  • Class Programming

    • Defining & Using Classes (GOBJ.pdf)

      Describes how to create and use classes and objects.

    • Class Definition Reference (ROBJ.pdf)

      Provides reference information on the structure of and elements used in class definitions.

  • API Manager

    InterSystems API Manager (IAM) which is powered by Kong Enterprise

  • SQL

    Use SQL with InterSystems IRIS.

    • Using SQL (GSQL.pdf)

      Provides information about using SQL with InterSystems databases.

    • SQL Text Search (GSQLSRCH.pdf)

      Describes InterSystems context-aware SQL text search.

    • SQL Security

      Managing security in SQL

    • Optimizing SQL

      • SQL Performance Overview (AGSOO.pdf)

        Improve SQL performance using SQL performance features.

      • How InterSystems IRIS Processes SQL Statements (AGSOS.pdf)

        Describes how InterSystems IRIS® processes SQL statements, from preparsing to compiling to plan generation to query code execution.

      • Best Practices for Improving SQL Performance (AGSOB.pdf)

      • Examine Query Performance (GSOE.pdf)

      • Defining a High-Performance Schema (GSOD.pdf)

      • Configure SQL Performance Options (GSOC.pdf)

    • InterSystems SQL Reference (RSQL.pdf)

      Provides reference material on InterSystems SQL commands, functions, and predicate conditions, and lists of data types and reserved words.

    • Using the InterSystems SQL Gateway (BSQG.pdf)

      Describes how to link to external databases via JDBC or ODBC and access data just as you would access InterSystems IRIS.

    • XDBC Gateway (BXDBC.pdf)

      Describes how to connect to external databases with the XDBC Gateway and access data just as you would access InterSystems IRIS.

  • Document Database (GDOCDB.pdf)

    Provides an overview of and details about the InterSystems DocDB.

  • Web Applications & APIs

    Provides an overview of creating custom web applications and APIs in InterSystems IRIS

    • Web Gateway (GCGI.pdf)

      Describes how to install, configure, and manage the InterSystems Web Gateway to connect to InterSystems products on supported operating systems.

    • Web Server Considerations

      • Apache Considerations (UNIX®/Linux/macOS) (APACHE.pdf)

        Discusses topics relevant to administering a Web Gateway connection using an Apache web server.

      • IIS Considerations (Windows) (AMIIS.pdf)

        Discusses topics relevant to administering a Web Gateway connection using Microsoft IIS.

    • REST and JSON

      Create and use RESTful services and use JSON with InterSystems databases

      • REST Services (GREST.pdf)

        Describes how to create REST services.

      • Using JSON (GJSON.pdf)

        Describes how to use InterSystems support for JSON.

    • WSGI (AWSGI.pdf)

      Describes how to create WSGI applications that use the InterSystems IRIS database.

    • SOAP

      Createand use web services and web clients with InterSystems products

      • Web Services & Clients (GSOAP.pdf)

        Describes how to create InterSystems-based web services and web clients.

      • Web Service Options (GSOAPSERV.pdf)

        Discusses various ways to fine-tune an InterSystems web service, when non-default behavior is needed.

      • Web Client Options (GSOAPCLI.pdf)

        Discusses various ways to fine-tune an InterSystems web client, when non-default behavior is needed.

      • SOAP Security (GSOAPSEC.pdf)

        Describes how to secure InterSystems-based web services and web clients.

    • CSP (GCSP.pdf)

      Describes how to use CSP to create a web application consisting of dynamic web pages.

    • WebSockets (AWEBSOCKETS.pdf)

      Describes how to use InterSystems IRIS support for the WebSockets protocol (RFC 6455) to enable two-way client-server communications.

  • Other Available APIs

    • File & Directory API (GFILE.pdf)

      Describes how to use the %Library.File class to list directory and drive contents; create, copy, and delete directories and files; set and get file attributes; read and write files; and perform other file operations.

    • XML Tools (GXML.pdf)

      Describes how to use InterSystems XML tools to work with XML-enabled classes, work with general XML documents, and customize use of the InterSystems SAX Parser.

    • XML Projections (GXMLPROJ.pdf)

      Describes how to project InterSystems objects to XML elements, attributes, and schemas.

    • Internet Utilities (GNET.pdf)

      Describes how to use Internet utility classes for HTTP requests, email, FTP, and other such basics.

    • External Messaging Platforms (GMESSAGE.pdf)

      Describes how to communicate with external messaging platforms by using low-level APIs

    • REST API for Source Code (GSCF.pdf)

      Describes how to access InterSystems source code files, which include class definitions and routines, using REST.

    • API Index (ITECHREF.pdf)

      Helps you find InterSystems APIs.

  • Other Topics

    • I/O Device Guide (GIOD.pdf)

      Describes I/O coding for various device types and for sequential files.

    • Bits & Bitstrings (ABIT.pdf)

      Provides an introduction to storing a sequence of bits as an integer or a bitstring.

    • Semaphores (ASEMAPHORE.pdf)

      Describes how to use Semaphores, which are instances of %SYSTEM.Semaphore.

    • String Localization (GSTRLOC.pdf)

      Provides an overview of string localization in InterSystems products and describes how to export, import, and manage message dictionaries.

    • Process Memory (AVMEM.pdf)

      Provides an overview of memory usage by processes in InterSystems products.

    • Work Queue Manager (GWORK.pdf)

      Describes how to use the Work Queue Manager to perform parallel processing.

    • Secure Logins (ASCWL.pdf)

      Describes approaches for properly securing web applications with InterSystems products.

  • Glossary (RGOT.pdf)

    Provides definitions of InterSystems terminology.

• External Language Development

  Learn about the client-side programming tools features provided and supported by InterSystems IRIS

  • Native SDKs

    Use the InterSystems IRIS native SDKs for direct access to embedded language resources

  • Using InterSystems External Servers (BEXTSERV.pdf)

    Explains how to access and manipulate Java, .NET, and Python objects from ObjectScript using External Servers and the $system.external Interface.

  • Java

    • JDBC for Relational Access

      Use the JDBC API for relational access

    • Demo: Connect with JDBC (AFL_JDBC.pdf)

      Introduces connecting to InterSystems databases via JDBC: quick facts, a look at shared memory connections, and a chance to try it for yourself.

    • Demo: Java and XEP (AFL_XEP.pdf)

      Introduces how to store and retrieve persistent Java objects using the XEP object persistence API: quick facts, a hands-on demo, and comparison with other Java persistence options.

    • Using Java (BJAVA.pdf)

      Describes InterSystems Java Connectivity Options and how they are supported by the InterSystems JDBC driver.

    • Native SDK for Java (BJAVNAT.pdf)

      Describes how to use the InterSystems Native SDK for Java to work with ObjectScript classes, objects, and multidimensional global arrays).

    • Persisting Java Objects with Java Persister (BJAVPER.pdf)

      Describes how to use the InterSystems Java Persister for high speed data serialization.

    • Persisting Java Objects with XEP (BJAVXEP.pdf)

      Describes how to use InterSystems event persistence (XEP) for rapid storage of Java objects.

    • InterSystems Implementation Reference for Third-party Software (BTPI.pdf)

      Provides technical details about how InterSystems products implement connectivity to external language libraries and drivers.

    • R Gateway Support (ARGATEWAY.pdf)

  • .NET

    Connecting InterSystems IRIS with .NET applications and tools

    • Demo: .NET and XEP (AFL_NETXEP.pdf)

      Introduces how to store and retrieve persistent .NET objects using the XEP object persistence API: quick facts and a hands-on demo.

    • Using .NET (BNET.pdf)

      Describes InterSystems .NET Connectivity Options and how they are supported by the InterSystems ODBC driver and ADO Managed Provider.

    • Native SDK for .NET (BNETNAT.pdf)

      Describes how to use the InterSystems Native SDK for .NET to work with ObjectScript classes, objects, and multidimensional global arrays).

    • Persisting .NET Objects with XEP (BNETXEP.pdf)

      Describes how to use InterSystems event persistence (XEP) for rapid storage of .NET objects.

    • ODBC

      Use the InterSystems ODBC driver for platform-independent access to database management systems

      • Using the InterSystems ODBC Driver (BNETODBC.pdf)

        Describes using the InterSystems ODBC driver to access InterSystems databases from external applications or to access external ODBC data sources from InterSystems products.

  • Native SDK for Python

    Use the InterSystems IRIS native SDK for Python to embedded language resources

    • Orientation for Python Developers (GPYDEV.pdf)

      Provides a Starting Point for Python Developers Who Are New to InterSystems IRIS.

    • Using the Native SDK for Python (BPYNAT.pdf)

      Describes how to use the Native SDK for Python to work with InterSystems classes, objects, and multidimensional global arrays.

  • Native SDK for Node.js

    Use the InterSystems IRIS native SDK for Node.js to embedded language resources

    • Using the Native SDK for Node.js (BJSNAT.pdf)

      Describes how to use the Native SDK for Node.js to work with InterSystems classes, objects, and multidimensional global arrays).

  • Callin (BXCI.pdf)

    Describes Callin, a low level programming interface that allows C/C++ programs to execute commands and expressions within InterSystems-based applications.

  • Callout (BGCL.pdf)

    Describes how to use the InterSystems $ZF Callout functions.

• Interoperability

  Connect people, processes, applications, and systems

  • Introducing Productions (EGIN.pdf)

    Interoperate between systems with productions, which can transform and route messages

  • Preparing to Create Productions (EPREP.pdf)

    Provides a road map for getting started with creating productions.

  • Production Best Practices (EGBP.pdf)

    Best practices for organizing and developing productions

  • Developing Productions

    Develop productions using Java, .NET, ObjectScript, SQL, or the graphic editors for business processes, data transformations and business rules

    • ObjectScript Productions (EGDV.pdf)

      Explains how to perform the development tasks related to creating a production.

    • Java, Python, & .NET Productions (EPEX.pdf)

      Create interoperability productions in external languages like Java, Python, and .NET

    • Business Logic

      • Developing BPL Processes (EBPL.pdf)

        Create business processes using the Business Process Language (BPL)

      • Developing DTL Transformations (EDTL.pdf)

        Describes how to create DTL data transformations

      • BPL and DTL Reference (EBPLR.pdf)

        Business Process Language (BPL) and Data Transformation Language (DTL) reference

      • Developing Business Rules (EBUS.pdf)

        Define business rules that direct business process logic

    • Enterprise Service Bus (EESB.pdf)

      Describes how to configure and use a production as an Enterprise Service Bus.

    • Workflow (EGWF.pdf)

      Incorporate human interaction into automated business processes

    • Push Notifications (EPUSH.pdf)

      Describes how to configure and use Push Notifications to send notifications to users on mobile devices.

  • Configuring and Managing Productions

    Control the lifecycle of an interoperability production: configure the production, deploy it to systems, manage the production, and monitor the production and messages

    • Configuring Productions (ECONFIG.pdf)

    • Managing Productions (EGMG.pdf)

      Use the Management Portal to manage productions

    • Monitoring Productions (EMONITOR.pdf)

      Monitor your production environment and production components

    • Testing Productions (TTEP.pdf)

      Hands-on tutorial for testing productions using %UnitTest.TestProduction

  • Communication Protocols

    • Protocols & Adapters

      Interoperability production adapters handle communication protocols

    • Message Formats

      Interoperability productions can receive and send messages in many formats including XML, X12, delimited or fixed-column files, or custom formats

    • Cloud Storage Adapters (ECLOUD.pdf)

      Describes how to access cloud storage using a production or low-level APIs.

    • CloudWatch Adapter (AECW.pdf)

      Describes how to use an interoperability production to send metric data to Amazon CloudWatch.

    • Email Adapters (EEMA.pdf)

      Configure and use email adapters

    • External Messaging Platforms (EMESSAGE.pdf)

      Describes how to communicate with external messaging platforms from within productions.

    • File Adapters (EFIL.pdf)

      Configure and use simple file adapters

    • FTP Adapters (EFTP.pdf)

      Configure and use FTP adapters

    • HTTP Adapters (EHTTP.pdf)

      Configure and use HTTP adapters

    • JMS (Legacy) (EJMS.pdf)

      Configure and use the Java Messaging Service (JMS) to send and receive messages in interoperability productions

    • IBM WebSphere MQ (EMQS.pdf)

      Describes how to configure and use MQ adapters.

    • MQTT (EMQTT.pdf)

      Describes how to configure and use Message Queuing Telemetry Transport (MQTT) adapters

    • REST Services and Adapters (EREST.pdf)

      Describes how to create REST business services and operations for productions.

    • SOAP Services and Web Clients (ESOAP.pdf)

      Describes how to create SOAP web services and web clients in InterSystems interoperability productions.

    • SAP Java Connector (ESAP.pdf)

      Describes how to interface with the SAP Java Connector in InterSystems interoperability productions.

    • SQL Adapters (ESQL.pdf)

      Describes how to interact with external data sources using an interoperability production

    • TCP Adapters (ETCP.pdf)

      Configure and use TCP adapters

    • Managed File Transfer (GMFT.pdf)

      Describes how to enable productions to use managed file transfer (MFT) services.

  • EDIFACT, X12, XML

    Route XML and other documents as virtual documents

    • Virtual Documents (EEDI.pdf)

      Work with Electronic Data Interchange (EDI) documents (EDIFACT and X12) as well as XML documents as virtual documents

    • EDIFACT (EACT.pdf)

      Add EDIFACT routing interfaces to productions

    • X12 (EX12.pdf)

      Explains how to add X12 routing interfaces to a production

    • XML Virtual Documents (EXML.pdf)

      Explains how to build productions that route and transform documents in XML format

  • Legacy User Interfaces

    • Legacy DTL Editor (EDTLOLD.pdf)

      Describes how to create DTL data transformations

    • Legacy Production Configuration Page (ECONFIGOLD.pdf)

• Analytics and Data Science

  Maximize your data's value through machine learning, business intelligence, and text analytics

  • Business Intelligence

    Embed InterSystems IRIS Business Intelligence in your applications

    • BI Introduction (D2GS.pdf)

      Introduces InterSystems IRIS Business Intelligence.

    • BI Modeling (D2MODEL.pdf)

      Describes how to define cubes, subject areas, and listing groups.

    • BI Advanced Modeling (D2MODADV.pdf)

      Describes how to use the more advanced and less common InterSystems IRIS Business Intelligence modeling features.

    • Using Dashboards and the User Portal (D2USER.pdf)

      Describes how to use the InterSystems IRIS User Portal and dashboards.

    • BI Dashboards (D2DASH.pdf)

      Describes how to create and modify dashboards in InterSystems IRIS Business Intelligence.

    • Implementing InterSystems IRIS Business Intelligence (D2IMP.pdf)

      Describes how to implement InterSystems IRIS Business Intelligence. Discusses settings, data connectors, actions, localization, packaging, performance, security, and more.

    • BI Analyzer (D2ANLY.pdf)

      Describes how to use the Analyzer to create pivot tables and to perform ad hoc analysis.

    • Using MDX (D2GMDX.pdf)

      Introduces MDX (MultiDimensional eXpressions) and describes how to use MDX with InterSystems IRIS Business Intelligence.

    • MDX Reference (D2RMDX.pdf)

      Provides reference information for MDX expression types, statements, functions, and intrinsic properties supported by InterSystems IRIS Business Intelligence.

    • Power BI (APOWER.pdf)

      Describes how to use the InterSystems Health Insight Connector for Power BI.

    • BI Clients (D2CLIENT.pdf)

      Provides information on the JavaScript API and REST API for InterSystems IRIS Business Intelligence.

    • BI Tutorial (D2DT.pdf)

      Describes how to create cubes and subject areas and use them to create pivot tables and dashboards.

  • Machine Learning

    Develop key insights in your data by training and applying predictive models

    • Using IntegratedML (GIML.pdf)

      Introduces IntegratedML.

    • AutoML Reference (GAUTOML.pdf)

      Introduces AutoML.

  • Text Analytics (Natural Language Processing) (GIKNOW.pdf)

    Describes the concepts and features of NLP unstructured data analysis.

  • Predictive Modeling Markup Language (APMML.pdf)

    Describes how to use PMML (Predictive Modelling Markup Language) models.

  • Unstructured Information Management Architecture (GUIMA.pdf)

    Describes the InterSystems implementation of the UIMA standard for processing unstructured data.

  • InterSystems Reports

    Reporting capability for InterSystems IRIS

  • InterSystems IRIS Adaptive Analytics (AADAN.pdf)

    Analytics with Dynamic Query Caching for InterSystems IRIS and InterSystems IRIS for Health