InterSystems IRIS Data Platform 2018.1
InterSystems: The power behind what matters   

All Documentation
This view lists all the content in this database. Other views focus on specific areas and provide additional links to related online courses, videos, and other useful items.
These topics provide introductory information for InterSystems IRIS Data Platform.
Installation Guide   
Describes the process of installing InterSystems IRIS on your system.
These topics explain the options that affect your architectural choices. Also see the Architecture and Planning view, which includes additional resources.
High Availability Guide   
Explains the many mechanisms provided by InterSystems products to maintain highly available and reliable systems.
Scalability Guide   
Explains how to scale InterSystems-based applications to meet the demands of your workload.
InterSystems Cloud Manager Guide   
Explains how ICM can be used to easily provision infrastructure and deploy containerized services in a public or private cloud.
These topics consist of the most commonly needed programming concepts and reference material for the InterSystems IRIS Data Platform.
Defining and Using Classes   
Describes how to create and use classes and objects.
ObjectScript Tutorial
Provides an interactive introduction to the ObjectScript language.
Using ObjectScript   
Provides an overview of and details about the ObjectScript programming language.
Using InterSystems SQL   
Provides information about using SQL with InterSystems databases.
InterSystems SQL Optimization Guide   
Provides information about improving performance of InterSystems SQL.
InterSystems SQL Reference   
Provides reference material on InterSystems SQL commands, functions, and predicate conditions, and lists of data types and reserved words.
ObjectScript Reference   
Provides reference material for ObjectScript.
Class Definition Reference   
Provides reference information on the structure of and elements used in class definitions.
Orientation Guide for Server-Side Programming   
Presents the essentials for programmers who write server-side code using InterSystems products.
%UnitTest Tutorial
Provides an interactive introduction to creating unit tests with the %UnitTest package.
InterSystems Error Reference   
Lists error codes associated with general operations, SQL, the database engine, and productions.
InterSystems Glossary of Terms   
Provides definitions of InterSystems terminology.
These topics describe additional options available to programmers who develop applications with the InterSystems IRIS Data Platform.
Creating REST Services   
Describes how to create REST services in InterSystems products.
Using JSON   
Describes how to use InterSystems support for JSON.
XML Tutorial
Provides an interactive introduction to InterSystems XML and web services features.
Web Services Quick Start Tutorial
Provides an interactive introduction to creating web service producers and consumers using InterSystems products.
Creating Web Services and Web Clients   
Describes how to create InterSystems-based web services and web clients.
Using Document Database (DocDB)   
Provides an overview of and details about the InterSystems DocDB.
Projecting Objects to XML   
Describes how to project InterSystems objects to XML elements, attributes, and schemas.
Using XML Tools   
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.
Using Internet Utility Classes   
Describes how to use Internet utility classes for HTTP requests, email, FTP, and other such basics.
Using Globals   
Describes the InterSystems multidimensional storage mechanism.
I/O Device Guide   
Describes I/O coding for various device types and for sequential files.
Accessing Source Code Files Using REST   
Accessing InterSystems source code files, which include class definitions, routines, and CSP files, using REST.
InterSystems Programming Tools Index   
Helps you find classes, routines, and other InterSystems programming tools.
Using the Terminal   
Describes how to use the ObjectScript command-line interface.
Using Studio   
Provides information on the Studio development environment.
These topics describes language bindings (used to write client applications in Java, C++, .NET, and other languages) and gateways (used to call external applications from within the InterSystems IRIS Data Platform).
Using Java with the InterSystems JDBC Driver   
Describes how to use the InterSystems JDBC driver, and how it supports other InterSystems Java solutions.
Persisting Java Objects with InterSystems XEP
Describes how to use the InterSystems event persistence API (XEP) for rapid storage of Java objects.
Using the Native API for Java
Describes how to use the InterSystems Native API to access multidimensional storage (globals) from Java.
InterSystems Implementation Reference for Java Third Party APIs   
Provides technical details about how InterSystems products implement connectivity to Java libraries and frameworks such as JDBC, Apache Spark, and Hibernate.
Using the InterSystems Managed Provider for .NET   
Explains how to access InterSystems products from .NET ADO client applications.
Using the InterSystems ODBC Driver
Describes using the InterSystems ODBC driver to access InterSystems databases from external applications or to access external ODBC data sources from InterSystems products.
Using the InterSystems SQL Gateway   
Describes how to link to external databases via JDBC or ODBC and access data just as you would access InterSystems objects.
Persisting .NET Objects with InterSystems XEP
Describes how to use the InterSystems event persistence API (XEP) for .NET.
Using the Object Gateway for .NET   
Explains how to instantiate an external .NET object and manipulate it as if it were a native object.
Using Node.js with InterSystems   
Describes how to access InterSystems products from a Node.js application.
Using the Callin API   
Describes Callin, a low level programming interface that allows C/C++ programs to execute commands and expressions within InterSystems-based applications.
Using the Callout Gateway   
Describes how to use the $ZF Callout functions.
These topics describe how to use the analytics capabilities of the InterSystems IRIS Data Platform.
Using InterSystems Natural Language Processing (NLP)   
Describes the concepts and features of NLP unstructured data analysis.
Using InterSystems SQL Search   
Describes InterSystems context-aware SQL text search.
Using InterSystems UIMA   
Describes the InterSystems implementation of the UIMA standard for processing unstructured data.
Using the InterSystems Spark Connector   
Describes how to use the InterSystems implementation of the Apache Spark Data Source API.
Introduction to InterSystems IRIS Business Intelligence   
Introduces InterSystems IRIS Business Intelligence.
Developer Tutorial for InterSystems IRIS Business Intelligence   
Describes how to create cubes and subject areas and use them to create pivot tables and dashboards.
Using the Analyzer   
Describes how to use the Analyzer to create pivot tables and to perform ad hoc analysis.
Creating Dashboards   
Describes how to create and modify dashboards in InterSystems IRIS Business Intelligence.
Implementing InterSystems IRIS Business Intelligence   
Describes how to implement InterSystems IRIS Business Intelligence. Discusses settings, data connectors, actions, localization, packaging, performance, security, and more.
Defining Models for InterSystems IRIS Business Intelligence   
Describes how to define cubes, subject areas, and listing groups.
Advanced Modeling for InterSystems IRIS Business Intelligence   
Describes how to use the more advanced and less common InterSystems IRIS Business Intelligence modeling features.
Using InterSystems MDX   
Introduces MDX (MultiDimensional eXpressions) and describes how to use MDX with InterSystems IRIS Business Intelligence.
InterSystems MDX Reference   
Provides reference information for MDX expression types, statements, functions, and intrinsic properties supported by InterSystems IRIS Business Intelligence.
Client-Side APIs for InterSystems IRIS Business Intelligence   
Provides information on the JavaScript API and REST API for InterSystems IRIS Business Intelligence.
Using Dashboards and the User Portal   
Describes how to use the InterSystems IRIS User Portal and dashboards.
These topics provide the most commonly needed information on building productions, including conceptual information, code examples, procedures, and reference information.
Introducing Interoperability Productions   
Introduces how to interoperate between systems by with productions, which can transform and route messages.
Preparing to Create Productions   
Provides a road map for getting started with creating productions.
Best Practices for Creating Productions   
Describes best practices for organizing and developing productions.
Developing Productions   
Explains how to perform the development tasks related to creating a production.
Configuring Productions   
Explains how to perform the configuration tasks related to creating a production.
Developing Business Rules   
Explains how to define business rules that direct business process logic.
Developing BPL Processes   
Describes how to write business processes using the Business Process Language (BPL).
Developing DTL Transformations   
Describes how to create DTL data transformations.
Business Process and Data Transformation Language Reference   
Describes each Business Process Language (BPL) element and each Data Transformation Language (DTL) element.
Testing Productions
Provides a hands-on tutorial for testing productions using %UnitTest.TestProduction.
How to use the adapters and gateways to control communication with external systems.
Using File Adapters in Productions   
Explains how to configure and use simple file adapters.
Using FTP Adapters in Productions   
Explains how to configure and use FTP adapters.
Enabling Productions to Use Managed File Transfer Services   
Describes how to enable productions to use managed file transfer (MFT) services.
Using HTTP Adapters in Productions   
Describes how to configure and use HTTP adapters.
Developing Productions with Java Business Services and Operations   
Explains how to add new protocols to InterSystems products using existing Java libraries.
Using SQL Adapters in Productions   
Describes how to configure and use SQL adapters.
Using TCP Adapters in Productions   
Explains how to configure and use TCP adapters.
Using REST Services and Operations in Productions   
Describes how to create REST business services and operations for productions.
Adding SOAP Services and Web Clients to Productions   
Describes how to create SOAP web services and web clients in InterSystems interoperability productions.
Using Email Adapters in Productions   
Describes how to configure and use email adapters.
Using IBM WebSphere MQ Adapters in Productions   
Describes how to configure and use MQ adapters.
Using the SAP Java Connector in Productions   
Describes how to interface with the SAP Java Connector in InterSystems interoperability productions.
Using the Java Gateway   
Explains how to enable easy interoperation between InterSystems products and Java components.
These topics describe how to build productions that route data in EDI formats (X12 and EDIFACT) or that route XML virtual documents.
Using Virtual Documents in Productions   
Explains how to work with Electronic Data Interchange (EDI) documents (EDIFACT and X12) as well as XML documents as virtual documents.
Routing X12 Documents in Productions   
Explains how to add X12 routing interfaces to a production.
Routing EDIFACT Documents in Productions   
Explains how to add EDIFACT routing interfaces to productions.
Routing XML Virtual Documents in Productions   
Explains how to build productions that route and transform documents in XML format.
These topics provide details on additional options for use with or within productions.
Defining Workflows   
Explains how to incorporate human interaction into automated business processes.
Using a Production as an ESB   
Describes how to configure and use a production as an Enterprise Service Bus.
Configuring and Using Push Notifications   
Describes how to configure and use Push Notifications to send notifications to users on mobile devices.
These topics provide information about configuring, administering, and monitoring the InterSystems IRIS Data Platform.
System Administration Guide   
Introduces common system administration tasks.
Monitoring Guide   
Describes the tools, routines, and third-party interfaces available to monitor InterSystems products.
Managing Productions   
Explains how to use the Management Portal to manage productions.
Monitoring Productions   
Explains how to monitor your production environment and production components.
Data Integrity Guide   
Explains the mechanisms used in InterSystems products to maintain data integrity.
Additional Configuration Settings Reference   
Describes settings in the Management Portal's Additional Settings section on the Configuration page.
Configuration Parameter File Reference   
Describes the purpose and syntax of entries in the Configuration Parameter File.
Web Gateway Configuration Guide   
Describes how to manually set up a web server and the InterSystems Web Gateway to connect to InterSystems products on supported operating systems.
Specialized System Tools and Utilities   
Describes tools and utilities for managing and extending InterSystems-based systems.
These topics describe security features available with the InterSystems IRIS Data Platform.
Security Tutorial
Provides an interactive introduction to InterSystems security.
Security Administration Guide   
Describes authentication, authorization, auditing, managed key encryption, SSL/TLS, and other aspects of InterSystems security.
Securing Web Services   
Describes how to secure InterSystems-based web services and web clients.
Using OAuth 2.0 and OpenID Connect   
Describes how to use InterSystems support for OAuth 2.0 and OpenID Connect.
These topics describe options for migrating from third-party database systems.
Transact-SQL (TSQL) Migration Guide   
Describes the InterSystems implementation of TSQL and how to migrate schemas and stored procedures from Sybase or SQL Server.
ISQL Migration Guide   
Describes the InterSystems implementation of ISQL and how to migrate schemas and stored procedures from Informix.
First Look: .NET Object Persistence with XEP
Introduces how to store and retrieve persistent .NET objects using the XEP object persistence API: quick facts and a hands-on demo.
First Look: ADO.NET and InterSystems Products   
Introduces connecting to InterSystems products via the InterSystems ADO.NET Managed Provider.
First Look: Atelier with InterSystems Products   
Introduces the Atelier plug-in for Eclipse and shows you how to use it to create and run a simple class file.
First Look: Connecting Systems Using Java Business Hosts   
Introduces creating business services and operations using Java Business Hosts.
First Look: Data Resiliency and Mirroring   
Introduces the crash recovery, high availability, and disaster recovery capabilities of InterSystems products.
First Look: Data Transformations   
Introduces the DTL Editor and how to transform data into a different format within an interoperability production.
First Look: Database Encryption   
Provides a brief, simple, hands-on introduction to InterSystems database encryption tools.
First Look: Deploying an InterSystems Sharded Cluster   
Introduces sharding and how it can be used to scale InterSystems-based applications for data volume.
First Look: Developing REST Interfaces in InterSystems Products   
Introduces developing REST interfaces in InterSystems products to provide access to databases and applications.
First Look: InterSystems Cloud Manager   
Introduces InterSystems Cloud Manager and shows you how to use it to deploy InterSystems products in a public cloud.
First Look: InterSystems IRIS Native API for Java   
Introduces how to access InterSystems globals from a Java application using InterSystems IRIS Native.
First Look: InterSystems Products in Docker Containers   
Introduces Docker containers and running InterSystems products in containers.
First Look: InterSystems SQL   
Introduces InterSystems SQL, the usage of common SQL statements with InterSystems products, and a unique way to optimize query performance.
First Look: Java Object Persistence with XEP   
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.
First Look: JDBC and InterSystems Databases   
Introduces connecting to InterSystems databases via JDBC: quick facts, a look at shared memory connections, and a chance to try it for yourself.
First Look: LDAP and InterSystems Products   
Introduces using an LDAP server to authenticate and assign privileges to users of InterSystems products.
First Look: Managed File Transfer (MFT) with Interoperability Productions   
Introduces the Managed File Transfer (MFT) feature, which enables easy inclusion of a third-party file transfer service directly into an InterSystems interoperability production.
First Look: ODBC and InterSystems Databases   
Introduces connecting to InterSystems databases via ODBC.
First Look: Optimizing SQL Performance with InterSystems Products   
Introduces InterSystems SQL query optimization techniques.
First Look: Role-Based Access Control   
Introduces role–based access control in InterSystems products: quick facts and a chance to try it for yourself.
First Look: Scaling Systems for User Volume with InterSystems Distributed Caching   
Introduces the use of distributed caching enabled by ECP to scale for user volume.
First Look: SQL Search with InterSystems Products   
Introduces support for SQL text search, which provides semantic context searching of unstructured text data.
First Look: Text Analytics with InterSystems Products   
Introduces support for Natural Language Processing (NLP) text analytics, which provides semantic analysis of unstructured text data in a variety of natural languages.
First Look: The InterSystems .NET Gateway   
Introduces working with the InterSystems .NET Gateway.
First Look: The InterSystems Public Key Infrastructure (PKI)   
Introduces public-key cryptography, Certificate Authorities (CAs), and PKI as available in InterSystems products.
First Look: The Java Gateway and InterSystems Products   
Introduces the ability of InterSystems products to interoperate with Java components through the Java Gateway.
Quick Start: InterSystems IRIS Installation   
Guides the user through a single-instance installation of InterSystems IRIS for use with First Look guides.
Adding Compiled Code to Customer Databases   
Describes how to add compiled, deployed code to customer databases.
Downloading Samples for Use with InterSystems Products   
Describes how to download samples for use with InterSystems products, as well as how to create a namespace and database to hold the samples.
FIPS 140–2 Compliance for Database Encryption   
Describes how to enable FIPS 140–2 compliant cryptography for database encryption.
InterSystems High Availability Solutions   
Discusses several general strategies for achieving high availability with InterSystems-based applications.
InterSystems IRIS Overview   
Provides a high-level overview of InterSystems IRIS.
Locating and Exploring Class Reference Documentation   
Describes how to locate and explore class reference documentation.
Locking and Concurrency Control   
Describes locking and concurrency control in InterSystems products.
Process Memory in InterSystems Products   
Provides an overview of memory usage by processes in InterSystems products.
Running InterSystems Products in Containers   
Describes how to deploy and run InterSystems products in Docker containers
Searching DocBook   
Provides details on the options provided by the DocBook native search engine.
Securing InterSystems Products and Operating System Resources   
Provides advice on reducing the potential for system compromise.
Semaphores in InterSystems Products   
Describes how to use Semaphores, which are instances of %SYSTEM.Semaphore.
Try-Catch FAQ   
Answers various questions about ObjectScript Try-Catch exception handling.
Using InterSystems IRIS Data Platform in a Public Cloud   
Explains how to use InterSystems products in public clouds
Using InterSystems IRIS Data Platform on Google Cloud Platform   
Explains how to use InterSystems products on Google Cloud Platform
Using PMML Models with InterSystems Products   
Describes how to use PMML (Predictive Modelling Markup Language) models.
Using the Classes Page   
Describes how to manage classes via the Management Portal.
Using the Work Queue Manager   
Describes how to use the work queue manager to perform parallel processing.
Working with %Status Values   
Describes how to examine %Status values, as well as how to return your own %Status values.