Documentation Home Page for Caché & Ensemble 2018.1
InterSystems: The power behind what matters   
Search:    
Welcome to the InterSystems documentation.
Click on one of the documents below to find more information.
You can use combinations of the buttons on the left to find out about specific topics.
Press Reset to start again.
Introduction to Caché   
Provides an overview of the features and major components of Caché.
Caché Release Notes and Upgrade Checklist   
Lists new features in this Caché release; discusses important topics to consider upon upgrading to this release.
Caché Release Notes and Upgrade Checklist Archive   
Contains release notes and upgrade issues for older releases.
Caché Installation Guide   
Describes the process of installing Caché on your system.
Using InterSystems Development Environments — Atelier and Studio   
Provides information on the Atelier and Studio development environments.
Caché Programming Orientation Guide   
Presents the essentials for programmers who write server-side Caché code.
Using Caché Objects   
Describes how to create and use Caché classes and objects.
Using Caché ObjectScript   
Provides an overview of and details about the ObjectScript programming language.
Using Caché SQL   
Provides information about using SQL with Caché.
Using Caché Basic   
Describes how to use the Basic programming language with Caché.
Caché SQL Optimization Guide   
Provides information about improving performance of Caché SQL.
Using Caché Globals   
Describes the Caché multidimensional storage mechanism.
Caché Transact-SQL (TSQL) Migration Guide   
Describes Caché implementation of TSQL and how to migrate schemas and stored procedures from Sybase or SQL Server.
Caché ISQL Migration Guide   
Describes Caché implementation of ISQL and how to migrate schemas and stored procedures from Informix.
Projecting Objects to XML   
Describes how to project Caché objects to XML elements, attributes, and schemas.
Using Caché XML Tools   
Describes how to use Caché XML tools to work with XML-enabled classes, work with general XML documents, and customize use of the Caché SAX Parser.
Using iKnow   
Describes the concepts and features of iKnow unstructured data analysis.
Using OAuth 2.0 and OpenID Connect with Caché   
Describes how to use Caché support for OAuth 2.0 and OpenID Connect.
Accessing Caché Source Code Files Using REST   
Accessing Caché source code files, which include class definitions, routines, and CSP files, using REST.
Caché ObjectScript Reference   
Provides reference material for the following elements of ObjectScript: operators and other symbols, all abbreviations, commands, functions, special variables, and structured system variables. It also includes information on legacy commands and functions.
Caché SQL Reference   
Provides reference material on InterSystems SQL commands, functions, and predicate conditions, and lists of data types and reserved words.
Caché Basic Reference   
Provides reference material for the various elements of Caché Basic: operators and symbols, commands, functions, constants, objects, and a list of reserved words. It also includes a summary of the Caché multidimensional data model.
Caché Class Definition Reference   
Provides reference information on the structure of and elements used in Caché class definitions.
InterSystems Programming Tools Index   
Helps you find classes, routines, and other InterSystems programming tools, within Caché and Ensemble.
Caché Error Reference   
Lists error codes associated with general operations, SQL, and the database engine itself.
Caché I/O Device Guide   
Describes I/O coding for various device types and for sequential files.
Caché Glossary of Terms   
Provides definitions of Caché terminology.
Using Zen   
Introduces Zen, the InterSystems framework for web application development.
Using Zen Components   
Describes how to use the built-in components that Zen provides for laying out tables, charts, forms, menus, dialogs, and other items for web applications.
Developing Zen Applications   
Addresses advanced Zen application programming issues such as security, localization, client side layout management, and custom components.
Using Zen Reports   
Explains how to generate reports based on data stored in Caché.
Using Caché Server Pages (CSP)   
Describes how to create Caché Server Pages, an architecture and toolset for creating dynamic web pages.
CSP Gateway Configuration Guide   
Describes how to manually set up a web server and the CSP Gateway to connect to Caché on supported operating systems.
CSP and HTML Tag Reference   
Describes CSP and HTML tags that can be used in Cache Server Pages
Creating REST Services in Caché   
Describes how to create Caché REST services.
Creating Web Services and Web Clients in Caché   
Describes how to create Caché web services and web clients.
Securing Caché Web Services   
Describes how to secure Caché web services and web clients.
Using Caché Internet Utilities   
Describes how to use Caché Internet utility classes for HTTP requests, email, FTP, and other such basics.
Using JSON in Caché   
Describes how to use Caché support for JSON.
Using Zen Mojo   
Describes how to use Zen Mojo to create web applications for mobile devices or desktops.
Using Zen Mojo Plugins   
Describes how to use Zen Mojo plugins.
Using the Callout Gateway   
Describes how to use the $ZF Callout functions.
Using Java with Caché   
Describes how to use the Caché Java Binding to access Caché from Java client applications.
Using Java with Caché eXTreme   
Describes how to use the Caché eXTreme event persistence (XEP) API.
Using .NET with Caché eXTreme   
Describes how to use the Caché eXTreme APIs for .NET: eXTreme event persistence (XEP).
Using Node.js with Caché   
Describes how to access Caché from a Node.js application.
Using C++ with Caché   
Describes how to use the Caché C++ Binding to access Caché from C++ client applications.
Using .NET and the ADO.NET Managed Provider with Caché   
Explains how to access Caché from .NET client applications, using either the Caché .NET Object Binding or the Caché implementation of the ADO.NET Managed Provider.
Using Perl with Caché   
Describes how to use the Caché Perl Binding to access Caché from Perl client applications.
Using Python with Caché   
Describes how to use the Caché Python Binding to access Caché from Python client applications.
Using ActiveX with Caché   
Describes how to use the Caché ActiveX binding to access Caché from any application that supports ActiveX objects.
Using the Caché Callin API   
Describes Callin, a low level programming interface that allows C/C++ programs to execute Caché commands and expressions.
Using Caché Direct   
Describes how client applications can use the Caché Direct interface (either an ActiveX control or a C++ API) to execute ObjectScript commands on a Caché server, ActiveX applications can use callbacks, allowing server-side ObjectScript to reference client interface controls.
Using Caché with ODBC   
Describes using the InterSystems ODBC driver to access InterSystems databases from external applications or to access external ODBC data sources from InterSystems products.
Using Caché with JDBC   
Describes how to connect to Caché from an external application using the Caché JDBC driver, and how to access external JDBC data sources from Caché.
Using the Caché ActiveX Gateway   
Describes how to use Caché Activate to manipulate an external ActiveX object as if it were a native Caché object.
Using the Caché Gateway for .NET   
Explains how to instantiate an external .NET object and manipulate it as if it were a native object within Caché.
Caché System Administration Guide   
Introduces common system administration tasks.
Caché Monitoring Guide   
Describes the tools, routines, and third-party interfaces available to monitor Caché.
Caché Security Administration Guide   
Describes authentication, authorization, auditing, managed key encryption, SSL/TLS, and other aspects of Caché security.
Caché Distributed Data Management Guide   
Describes how to configure, manage, and develop distributed systems using the Enterprise Cache Protocol (ECP)
Caché Data Integrity Guide   
Explains the mechanisms Caché uses to maintain data integrity.
Caché High Availability Guide   
Explains the many mechanisms Caché provides to maintain highly available and reliable systems.
Caché Additional Configuration Settings Reference   
Describes settings in the Management Portal's Additional Settings section on the Configuration page.
Caché Parameter File Reference   
Describes the purpose and syntax of entries in the Caché parameter file.
CHARWIN: Character-based Windowing API   
Describes how to use the %CHARWIN mnemonic space and TERCAP utility to build windowing interfaces on character-based terminals.
MSM to Caché Conversion Guide   
Describes how to convert from MSM version 4.1.x to Caché version 5.0.x.
Caché Specialized System Tools and Utilities   
Describes tools and utilities for managing and extending Caché systems.
Using the MultiValue Features of Caché   
Introduces Caché and its MultiValue features, including version status, an installation overview, and a sample session.
Caché Concepts For MultiValue Developers   
Introduces important Caché features and ideas.
Operational Differences between MultiValue and Caché   
Provides an overview of the differences between Caché and other MultiValue implementations.
The Caché MultiValue Spooler   
Describes how printing is handled on Caché for MultiValue programs.
Caché MultiValue Terminal Independence   
Provides an overview of how Caché implements terminal independent I/O.
Caché MultiValue Basic Reference   
Provides reference material for the various elements of Caché MVBasic: commands, functions, constants, operators and symbols, and a list of the reserved words in Caché MVBasic.
Caché MultiValue Commands Reference   
Describes the command line commands (verbs) implementation in Caché MultiValue.
Caché MultiValue PROC Reference   
Describes the PROC commands for Caché MultiValue.
Caché MultiValue Query Language (CMQL) Reference   
Describes the CMQL query clauses for Caché MultiValue.
MultiValue Basic Quick Reference   
Summarizes the differences between Caché MVBasic and other variants.
Getting Started with DeepSee   
Introduces DeepSee.
DeepSee Developer Tutorial   
Describes how to create DeepSee cubes and subject areas and use them to create pivot tables and dashboards.
Defining DeepSee Models   
Describes how to define DeepSee cubes, subject areas, and listing groups.
Advanced DeepSee Modeling Guide   
Describes how to use the more advanced and less common DeepSee modeling features: computed dimensions, unstructured data in cubes, compound cubes, cube relationships, term lists, quality measures, KPIs, plugins, and other advanced options.
DeepSee Implementation Guide   
Describes how to implement DeepSee. Discusses settings, data connectors, actions, localization, packaging, performance, security, and more.
Tools for Creating DeepSee Web Clients   
Provides information on the DeepSee JavaScript API and REST API.
Using MDX with DeepSee   
Introduces MDX (MultiDimensional eXpressions) and describes how to use MDX with DeepSee.
DeepSee MDX Reference   
Provides reference information for MDX expression types, statements, functions, and intrinsic properties supported by InterSystems DeepSee.
Using the DeepSee Analyzer   
Describes how to use the DeepSee Analyzer to create pivot tables and to perform ad hoc analysis.
Creating DeepSee Dashboards   
Describes how to create and modify dashboards in DeepSee.
DeepSee End User Guide   
Describes how to use the DeepSee User Portal and dashboards.
Using DeepSee Visual Reporting   
Explains how to use DeepSee Visual Reporting to generate reports.
Using InterSystems Documentation   
Provides an overview of InterSystems product documentation.
Using the Terminal   
Describes how to use the Caché command-line interface.
Caché Tutorial Topics Map
Lists Caché topics and their associated tutorials.
Caché QuickStart Tutorial
Provides an interactive introduction to building Web-based applications using Caché.
Caché Security Tutorial
Provides an interactive introduction to Caché security.
MultiValue Quick Start Tutorial
Provides an interactive introduction to the MultiValue features of Caché.
Jalapeño Tutorial
Provides an interactive introduction to using Jalapeño to store Java objects to Caché.
Zen QuickStart Tutorial
Provides an interactive introduction to the Zen Web application framework.
Caché Java Binding and JDBC QuickStart Tutorial
Provides an interactive introduction to accessing Caché objects from Java.
Caché Managed Provider for .NET Tutorial
Provides an interactive introduction to connecting .NET applications to Caché.
Caché Web Services QuickStart Tutorial
Provides an interactive introduction to creating Web Service producers and consumers using Caché.
Caché %UnitTest Tutorial
Provides an interactive introduction to creating unit tests with the %UnitTest package.
Caché Server Pages QuickStart
Provides an interactive introduction to Caché Server Pages (CSP).
Caché XML Tutorial
Provides an interactive introduction to Caché XML and Web services features.
Caché Web Applications Tutorial
Provides an interactive introduction to the details of building a Web-based database application.
Caché Basic Tutorial
Provides an interactive introduction to the Caché Basic language.
ObjectScript Tutorial
Provides an interactive introduction to the ObjectScript language.
Preparing to Use Ensemble   
Provides a road map for installing, upgrading, and getting started with Ensemble.
Ensemble Release Notes   
Describes the contents of this release of Ensemble as well as compatibility issues with previous releases.
Ensemble Release Notes Archive   
Describes the contents of past releases of Ensemble as well as compatibility issues in those releases.
Introducing Ensemble   
Introduces Ensemble and options to include in your Ensemble productions.
Ensemble Best Practices   
Describes best practices for organizing and developing Ensemble productions.
Developing Ensemble Productions   
Explains how to perform the development tasks related to creating an Ensemble production. Many of these tasks require Studio.
Configuring Ensemble Productions   
Explains how to perform the configuration tasks related to creating an Ensemble production.
Developing Business Rules   
Explains how to define business rules that direct business process logic.
Developing BPL Processes   
Describes how to write Ensemble business processes using the Business Process Language (BPL).
Developing DTL Transformations   
Describes how to create DTL data transformations.
Defining Workflows   
Explains how to incorporate human interaction into automated business processes.
Business Process and Data Transformation Language Reference   
Describes each Business Process Language (BPL) element and each Data Transformation Language (DTL) element.
Ensemble Error Reference   
Describes the error codes associated with Ensemble.
Managing Ensemble   
Explains how to use the Management Portal to manage Ensemble productions.
Monitoring Ensemble   
Explains how to monitor your Ensemble environment and the Ensemble production components.
Ensemble Virtual Documents   
Explains how to work with Electronic Data Interchange (EDI) documents (ASTM, EDIFACT, HL7 version 2, and X12) as well as XML documents as Ensemble virtual documents.
Ensemble HL7 Version 2 Development Guide   
Explains how to build Ensemble productions that route and transform HL7 Version 2 messages.
Ensemble HL7 Version 3 Development Guide   
Explains how to build Ensemble productions that route and transform HL7 Version 3 messages.
Ensemble X12 Development Guide   
Explains how to add X12 routing interfaces to a production.
Ensemble ASTM Development Guide   
Explains how to add ASTM routing interfaces to productions.
Ensemble EDIFACT Development Guide   
Explains how to add EDIFACT routing interfaces to productions.
Ensemble DICOM Development Guide   
Explains how to build Ensemble productions that process documents in DICOM format.
Ensemble XML Virtual Document Development Guide   
Explains how to build Ensemble productions that route and transform documents in XML format.
Using Ensemble as an ESB   
Describes how to configure and use Ensemble as an Enterprise Service Bus
Using the Ensemble NHS Interoperability Toolkit   
Explains how to use the Ensemble Interoperability Toolkit to prescribe how applications in the English NHS communicate with each other.
Using Email Adapters with Ensemble   
Describes how to configure and use email adapters.
Using File Adapters with Ensemble   
Explains how to configure and use simple file adapters.
Using FTP Adapters with Ensemble   
Explains how to configure and use FTP adapters.
Using HTTP Adapters with Ensemble   
Describes how to configure and use HTTP adapters.
Using IBM WebSphere MQ Adapters with Ensemble   
Describes how to configure and use MQ adapters.
Using the Java Gateway   
Explains how to enable easy interoperation between Ensemble and Java components.
Using the Object Gateway for .NET with Ensemble   
Explains how to enable easy interoperation between Ensemble and the Caché Object Gateway for .NET.
Configuring and Using Ensemble Push Notifications   
Describes how to configure and use Ensemble Push Notifications to send notifications to users on mobile devices.
Using the SAP Java Connector with Ensemble   
Describes how to interface with the SAP Java Connector in Ensemble.
Creating REST Services and Clients with Ensemble   
Describes how to create Ensemble REST services and clients.
Creating SOAP Services and Web Clients with Ensemble   
Describes how to create Ensemble SOAP web services and web clients.
Using SQL Adapters with Ensemble   
Describes how to configure and use SQL adapters.
Using TCP Adapters with Ensemble   
Explains how to configure and use TCP adapters.
Ensemble Tutorial Topics Map
Lists Ensemble topics and their associated tutorials.
Testing Ensemble Productions
Test Ensemble productions using %UnitTest.TestProduction