sorodriguezz/skills/intersystems-api-index

InterSystems API Index

Tools Index

This reference is organized into topics that correspond either to a kind of item you might want to manipulate programmatically (class definitions, DDL files, and so on), a technology of interest (HTTP , XML, and so on), or a task you might be interested in (testing, debugging, and so on).

It lists the APIs for some tasks that are commonly performed in the Management Portal, if those are tasks you might need to perform programmatically.

Healthcare data formats are listed elsewhere.

Amazon CloudWatch (Tools/APIs)

Monitor an application by collecting data for a metric defined in Amazon CloudWatch.

Amazon CloudWatch is an AWS product that allows you to monitor an application by collecting data for specific metrics.

Amazon CloudWatch adapters

Monitor an application by collecting data for a metric defined in Amazon CloudWatch.

See Using the Amazon CloudWatch Adapter.

Availability: All interoperability-enabled namespaces.

Amazon Messaging Platforms (Tools/APIs)

Amazon Messaging Platforms (Tools/APIs)

Work with Amazon SNS and Amazon SQS messages.

Amazon Simple Notification Service ( Amazon SNS) is a managed service that provides message delivery from publishers to subscribers. Amazon Simple Queue Service (SQS) is another Amazon messaging platform.

Amazon SNS outbound adapter

Send a SNS message from a production.

See Sending Messages to Amazon SNS from a Production.

Availability: All interoperability-enabled namespaces.

Amazon SNS messaging API

Send SNS messages.

See Using the Amazon SNS Messaging API.

Amazon SQS messaging API

Send and receive SQS messages.

See Using the Amazon SQS Messaging API.

Application Management (Tools/APIs)

Work with web applications, privileged routine applications, and client applications (create, modify, export, and so on).

In InterSystems terminology, there are three kinds of applications: web applications, privileged routine applications, and client applications.

You define applications and specify their security via the Management Portal; see Defining Applications.

Security.Applications class

Persistent class that contains the application definitions. This class provides method like the following:

• Create()

• Delete()

• Export()

• And others

It also provides the following class queries:

• Detail()

• List()

Archiving (Tools/APIs)

Archiving (Tools/APIs)

Archive files to an archi ve server.

%Archive package

Enable you to archive files to an archi ve server. %Archive.Session is an API for data archiving; the class reference contains details and examples. %Archive.Content represents the source or target of an archive operation.

Auditing (Tools/APIs)

Add entries to the audit log.

Auditing is the process of automatically recording selected actions, including actions of the authentication and authorization systems. In InterSystems IRIS® data platform, auditing is considered a security function. The Management Portal provides pages you can use to enable auditing, configure custom audit e vents, and view the audit log.

See Auditing Guide.

%SYSTEM.Security class

Provides the Audit() method, which enables you to add your own entries to the audit log.

%SYS.Audit class

Persistent class that contains the audit log. This class provides class queries like the following:

• ListByEvent()

• ListByPid()

• And others.

^%AUDIT routine

Allows the reporting of data from the logs, and the manipulation of entries in the audit logs as well as the logs themselves. See Command-Line Security Management Utilities.

^LOGDMN routine and SYS.LogDmn class

Enable you to set up structured logging, which will write the same messages seen in the audit database to a machinereadable file that can be ingested by your choice of monitoring tool. See Setting Up Structured Logging.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

C (Tools/APIs)

C (Tools/APIs)

Access InterSystems IRIS® data platform from C programs.

C is a commonly used programming language.

InterSystems Callin API

Enables you to access InterSystems IRIS from C programs. You can execute ObjectScript commands and evaluate InterSystems IRIS expressions. The Callin API permits a wide variety of applications. For example, you can use it to create an interface between ObjectScript and an application that presents an integrated menu or GUI. If you gather information from an external device, such as an Automatic Teller Machine or piece of laboratory equipment, the Callin API lets you store this data in an InterSystems IRIS database. Any language that uses the C/C++ calling standard for that platform can invoke the Callin functions.

See Using the Callin API.

Class Definitions (Tools/APIs)

Work with class definitions and class members programmatically (obtain information about, define, mak so on).

e deployed, and

For information on creating class definitions in InterSystems IRIS® data platform, see Defining and Using Classes and the Class Definition Reference. In InterSystems IRIS, a class member is a method, property, parameter, or other element of a class definition.

You can examine, compile, and export classes in your IDE.

You can export class definitions to files in UDL format or in XML format. UDL format more closely resembles what you see in an IDE.

%Dictionary package

Provides persistent classes you can use to examine class definitions, modify class definitions, create ne w classes, and even write programs that automatically generate documentation. There are two parallel sets of class definition classes: those that represent defined classes and those that represent compiled classes. F or example, you can use %Dictionary.ClassDefinition to work with class definitions, and you can use %Dictionary.CompiledClass to work with compiled classes.

There are similar classes in the %Library package, but the latter classes are deprecated.

See Class Definition Classes.

Provides methods for working with class definitions and other Studio items. These include:

• Compile()

• Delete()

• Export()

• ExportUDL()

• ExportAllClasses()

• GetClassList()

• GetDependencies()

• Import()

• New for 2025.1, this method enables you to import a single file or multiple files in a directory ImportDir(), Load(), and LoadDir() are now deprecated.

. The methods

IsUpToDate()

• MakeClassDeployed()

• ShowClasses()

• UnCompile()

Class Definitions (Tools/APIs)

• Upgrade()

• And others

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• Connecting an IDE

• Integrating InterSystems IRIS with Source Control Systems Cloud Storage (Tools/APIs) Store and retrieve data stored on a cloud storage provider.

Cloud storage providers such as Amazon Web Services (AWS), Azure Blob Storage (Azure), or Google Cloud Platform (GCP) enable you to store data on off-site servers that are fully managed by the provider.

Cloud storage adapters

Store and retrieve data stored on a cloud storage provider from within a production.

See Accessing Cloud Storage.

Availability: All interoperability-enabled namespaces.

Cloud storage APIs

Store and retrieve data stored on a cloud storage provider.

See Accessing Cloud Storage.

Concurrency Mode (Tools/APIs)

Concurrency Mode (Tools/APIs)

Get and set the concurrency mode for the current process.

See the entry for Locks for background information on concurrency. Also see Object Concurrency.

The concurrency mode determines what type of locking is performed when you access an object.

Includes the following class methods:

• GetConcurrencyMode()

• SetConcurrencyMode()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

CPF (Tools/APIs)

Modify the CPF programmatically (change settings such as memory and journal settings, define mappings, configure devices, and so on).

The CPF (Configuration P arameter File) contains a set of parameters that affect how InterSystems IRIS® data platform operates. InterSystems IRIS reads this file for configuration settings when it starts up. F or more information, see Introduction to the Configuration P arameter File.

The CPF can be modified programmatically through the configuration mer vidual settings can also be modified using the Management Portal.

ge feature and a number of classes. Most indi-

configuration merge feature

The ISC_CPF_MERGE_FILE environment variable lets you specify a configuration mer ge file, which contains one or more configuration settings to be mer ged into the CPF with which a new instance is installed or deployed before the instance is first started. You can modify the configuration of an e xisting instance in similar fashion using the iris merge command or by setting ISC_CPF_MERGE_FILE when starting or restarting. The configuration merge feature supports the automated deployment of multiple differently-configured instances from the same source (container image or installation kit), as well as automated reconfiguration. F or more information, see Automating Configuration of InterSystems IRIS with Configuration Mer

ge.

Config package

Most of the classes in this package enable you to modify the CPF. Classes in this package include:

• Config.Databases

• Config.MapGlobals

• Config.SQL

• Config.Startup

• And others Many of these classes are persistent and many provide class queries.

Provides the following method:

• GetCPFFileName() CPUs (Processors) (Tools/APIs) CPUs (Processors) (Tools/APIs)

Obtain information about CPUs (processors).

%SYSTEM.CPU class

Holds information about available processors.

Includes the NumberOfCPUs() class method, which you can use to discover the number of CPUs on the system.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

CSV Files (Tools/APIs)

Work with CSV (comma-separated values) data sources.

CSV (comma-separated values) is a simple, common format for data. For example, you can export to a .csv file from Microsoft Excel.

LOAD DATA SQL command

Load from CSV files into SQL tables using only InterSystems SQL. F or more details, see LOAD DATA.

Record Mapper

Map CSV data into a production. For more details, see Using the Record Mapper.

Interactive CSV Import/Export

Import/export SQL data to or from a CSV file interacti vely by using the Management Portal. Use this option if you need to import or export data a single time. For more details, see Importing and Exporting SQL Data.

Current Date and Time (Tools/APIs)

Current Date and Time (Tools/APIs)

Obtain the current date and time.

ObjectScript provides a special variable ($HOROLOG) that you can use to obtain the current date and time; see Date and Time Values. Note that $HOROLOG is available within SQL queries (as are other special variables).

In addition, InterSystems provides the following tools:

Includes the following class methods that return current date/time values:

• Horolog()

• TimeStamp()

%Library.Utility class

Includes the following class methods that return current date/time values:

• Date()

• DateTime()

• Time()

%Library.UTC class

Includes the following class methods that return current date/time values:

• NowLocal()

• NowUTC()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• Date/Time Values

Databases (Tools/APIs)

Manage database files programmatically (disable and enable journaling, cop y, configure, and so on).

InterSystems IRIS® data platform stores data and code in database files. F or an introduction, see Namespaces and Databases.

Typically you create and configure databases via the Management Portal. See Configuring Databases.

SYS.Database class

Represents InterSystems IRIS database files, as configured in an instance of InterSystems IRIS. Properties of this class specify configuration details for that database as well as current read-only details such as size and last expansion time.

Methods in this class enable you to work with database files. These methods include:

• Copy()

• DisableJournaling()

• EnableJournaling()

• GetDatabaseFreeSpace()

• And others

This class also provides queries that provide information about databases. These queries include:

• FreeSpace()

• List()

• RemoteDatabaseList()

• And others

Config.Databases class

Enables you to modify and obtain information about the [Databases] section of the CPF. (Note that you usually perform this configuration via the Management Portal, as noted abo ve.)

The class also provides the List() and MirrorDatabaseList() class queries.

The class documentation includes examples and details.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

Databases (Tools/APIs)

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure databases and namespaces.

^DATABASE routine

This routine provides ways to manage databases; it is an alternative to using the Management Portal. For details, see ^DATABASE.

• Namespaces Date/Time Values (Tools/APIs) Work with date/time values.

The tools are grouped into the following categories: data type classes and tools to work with date/time values.

Available Data Type Classes

Class Name

Logical Value

ODBC Type

DATE

XSD Type

date

%Date

%Time

%TimeStamp

A date value in $HOROLOG format (see Current Date and Time). For example: 46674

A time value, expressed as the number of seconds past midnight. For example: 67080

TIME

time

A date value and a time value, in ODBC format (in YYYY-MM-DD HH:MM:SS.nnnnnnnnn). For example: 1968-10-15 18:38:47

TIMESTAMP

dateTime

%UTC

A UTC date and time value, in ODBC format.

TIMESTAMP

Available Tools for Working With Date/Time Values

Includes the TimeZone() class method.

%SYSTEM.SQL.Functions class

Includes class methods that you can use to work with date/time values. These include:

• A large set of methods that implement SQL functions to extract date parts (DAYOFWEEK(), MONTHNAME(), YEAR(), and so on). You can use these methods in the same way that you use other class methods; you are not restricted to an SQL context.

• Methods that implement SQL date conversion functions (CONVERT(), TODATE(), and TOTIMESTAMP())

• Methods that add and subtract dates (DATEADD() and DATEDIFF())

Includes the following class methods that you can use to convert or obtain information about date/time values:

• IsDST()

• LocalWithZTIMEZONEtoUTC()

• UTCtoLocalWithZTIMEZONE()

%Library.UTC class

Provides a set of class methods for working with %TimeStamp values. These are as follows:

Date/Time Values (Tools/APIs)

• Compare()

• ConvertHorologToTimeStamp()

• ConvertUTCtoLocal()

• LogicalToOdbc()

• And others

Note

The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• Current Date and Time

DDL (Tools/APIs)

Work with DDL statements and with DDL files.

Generically, DDL means data definition language, which refers to syntax for defining data structures. SQL pro vides a set of statements for this purpose, and they are known collectively as SQL DDL. A DDL file is a text file that contains a series of these statements.

InterSystems SQL

InterSystems SQL includes support for SQL DDL. For information, see Defining Tables and Defining Views, which discuss DDL as one of the techniques for defining tables and vie ws.

%SYSTEM.SQL.Schema class

Includes class methods for working with DDL files, including the follo wing:

• ImportImport()

• ImportDDLDir()

• And others Some of these methods require specific permissions.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• SQL

Devices (Tools/APIs)

Devices (Tools/APIs)

Work programmatically with devices such as printers; configure; query for list of de vices.

ObjectScript provides commands for working with devices. For details, see the I/O Device Guide and ObjectScript Reference.

In addition, InterSystems provides the following tools:

%Device class

Provides a set of class methods for working with devices. These include:

• Broadcast()

• ChangePrincipal()

• Get()

• GetReadTerminators()

• GetReadType()

• And others

%SYS.NLS.Device class

Exposes some NLS properties of the current device and provides methods for changing those properties.

Config.Devices and Config.DeviceSubTypes classes

Enable you to modify and obtain information about the [Devices] and [DeviceSubTypes] sections of the CPF. (Note that you usually modify this file via the Management Portal. See De vices and DeviceSubTypes.)

Each class also provides a class query called List().

The class documentation includes examples and details.

• Files Directories and Drives (Tools/APIs) Work with directories and drives programmatically.

%File class

Includes utility methods for working with directories and drives. These methods include:

• CopyDir()

• CreateDirectory()

• CreateDirectoryChain()

• DirectoryExists()

• DriveListFetch()

• GetDirectoryPiece()

• GetDirectorySpace()

• ParentDirectoryName()

• SetReadOnly()

• And others

This class also provides the following class queries:

• DriveList()

• FileSet()

• ParseDirectory()

• Operating System Commands

Email (Tools/APIs)

Email (Tools/APIs)

Send and receive email programmatically.

%Net.MailMessage class and other classes in the %Net package

Support email as follows:

• InterSystems IRIS® data platform provides an object representation of MIME email messages. It supports text and non-text attachments, single-part or multipart message bodies, and headers in ASCII and non-ASCII character sets.

• You can send email via an SMTP server. SMTP (Simple Mail Transport Protocol) is the Internet standard for sending email.

• You can also retrieve email from an email server via POP3, the most common standard for retrieving email from remote servers.

For details and examples, see Using Internet Utilities.

email adapters

Enable a production to send and receive email. These adapters are built on the basic support provided in the %Net package. See Using Email Adapters in Productions.

Availability: All interoperability-enabled namespaces.

Note:

InterSystems IRIS does not provide an email server. Instead, it provides the ability to connect to and interact with email servers. The Management Portal uses the same API that is provided for you. Multiple parts of the Management Portal can send email automatically in the case of various events; an administrator specifies an SMTP serv er to use and other details as needed.

• MIME

Encryption (Tools/APIs)

Protect information against unauthorized viewing.

Encryption is the process of using a mathematical algorithm to transform information so that it becomes unreadable. The information is then available only to those who possess the key that can be used for decryption.

Managed key encryption

InterSystems IRIS® data platform includes support for managed key encryption, a suite of technologies that protect data at rest.

TLS

SOAP

XML

InterSystems IRIS TLS support includes the ability to encrypt communications.

InterSystems IRIS SOAP support includes the ability to encrypt and decrypt SOAP messages.

InterSystems IRIS XML support includes the ability to encrypt and decrypt XML documents.

%SYSTEM.Encryption class

Provides methods to perform data encryption, base–64 encoding, hashing, and generation of message authentication codes. The preceding encryption tools use these methods. Methods in this class include:

• AESCBCDecrypt()

• AESCBCManagedKeyDecrypt()

• AESGCMEncrypt()

• ActivateEncryptionKey()

• GenCryptRand()

• HMACSHA()

• RSAGetLastError()

• And others Availability: Some methods can be used in all namespaces. Some are available only in %SYS.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Encryption (Tools/APIs)

Environment Variables (Tools/APIs)

Access the value of an environment variable.

Provides the GetEnviron() method.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Exporting Data (Tools/APIs)

Exporting Data (Tools/APIs)

Export data programmatically.

The Management Portal provides two generic options for exporting data:

• The Data Export Wizard, which exports data from SQL tables. See Exporting Data to a Text File.

• The Export Globals page, which exports globals to .gof files. See Exporting Globals.

%SQL.Export.Mgr class

Enables you to export SQL tables to text files. F or information, see %SQL.ExImData, the utility class from which %SQL.Export.Mgr inherits.

%Global class

Includes the Export() class method.

Numerous tools within InterSystems IRIS® data platform provide more specific e xport options, documented elsewhere.

Extents (Tools/APIs)

Work with extent definitions programmatically .

Each persistent class has an extent, which consists of all saved instances of that class. See Extents.

%ExtentMgr.Util class

Maintains extent definitions and globals re gistered for use by those extents. Extent definitions most commonly originate from compiling a persistent class but can also be defined outside of an y class. This class provides a public interface for deleting extent definitions and re gistering the extents of all managed extent classes or a single class.

In addition to the public interface implemented here, the %ExtentMgr tables are visible to SQL and can be queried directly. There are two examples implemented in this class: GlobalUses() and GlobalsUsed(). Both are public class methods that return a single result set and both are projected as stored procedures and can be invoked by dynamic SQL, embedded SQL or through a database driver. These methods are more important as examples of how the %ExtentMgr tables can be queried.

Files (Tools/APIs)

Files (Tools/APIs)

Work with files programmatically (read, write, cop y, rename, and so on).

Background ObjectScript provides commands for working with files and other de vices.

In addition, InterSystems IRIS® data platform provides the following tools:

%File class

Represents disk files and provides utility methods for working with files, directories, and dri ves. This class includes instance methods like the following:

• Clear()

• Open()

• Rewind()

• And others

And it also contains class methods like the following:

• ComplexDelete()

• CopyFile()

• ManagerDirectory()

• NormalizeFilenameWithSpaces()

• Rename()

• SetReadOnly()

• TempFilename()

• And others See Using %Library.File.

file adapters

Enable a production to read and write files. See Using File Adapters in Productions.

These adapters are included automatically in many specialized business host classes.

Availability: All interoperability-enabled namespaces.

• Devices

FTP (Tools/APIs)

Use FTP from within InterSystems IRIS® data platform.

File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host o ver the Internet or other TCP-based networks.

%Net.FtpSession class

Enables you to you to establish a session with an FTP server from within InterSystems IRIS. For details and examples, see Using Internet Utilities.

FTP adapters

Enable a production to receive and send files between local and remote systems via the File Transfer Protocol (FTP). See Using FTP Adapters in Productions.

These adapters are included automatically in many specialized business host classes.

Availability: All interoperability-enabled namespaces.

Manage globals programmatically (import, export, get size, set collation, configure mappings, and so on).

InterSystems IRIS® data platform stores all data in its databases in globals. A single set of rules governs the names of globals and the names of their subscripts (that is, different languages do not have different rules). See Introduction to Globals and Using Globals.

You can define global mappings so that you can access data in a non-default location; see Configuring Namespaces. Typically you do this within the Management Portal.

The Management Portal also provides options for examining and managing globals. See Managing Globals.

The fundamental tool for working with globals is the ObjectScript language. In addition, InterSystems provides the following tools:

^%GSIZE routine

Enables you to obtain information on the size of globals. As of release 2024.1, this routine provides options for estimates, which are useful in the case of large globals that are time-consuming to fully examine.

^$GLOBAL

This structured system variable returns information about globals.

%Global class

Provides the following class methods:

• Export()

• Import() %GlobalEdit class

Enables you to see and modify properties of globals. It provides the methods like the following:

• CheckIntegrity()

• CollationSet()

• GetGlobalSize()

• GetGlobalSizeBySubscript()

• KillRange()

• And others This is a persistent class containing information about all globals. Given a global name, you can use Open() to open an instance of the class and access properties such Directory, IsEmpty, and Collation.

%SYS.GlobalQuery class

Provides the queries that return information about globals such as the namespaces they are available in, the database they are stored in, and whether they have subscripts. The available queries are as follows:

• DirectoryList()

• NameSpaceList()

• NameSpaceListChui()

• Size()

%Studio.Global class

Provides an interface to globals. It includes methods like the following:

• GlobalListClose()

• Kill()

• Set()

• And others It also provides a couple of queries.

Provides the following methods that you can use with globals:

• Export()

• ExportToStream()

• Load()

%ExtentMgr.Util class

Maintains extent definitions and globals re gistered for use by those extents. It includes the following methods:

• GlobalUses()

• GlobalsUsed() The %ExtentMgr tables are visible to SQL and can be queried directly. For details, see the reference for %ExtentMgr.Util.

Config.MapGlobals class

Enables you to modify and obtain information about the [Map.xxx] section of the CPF, which defines global mappings. (Note that you usually perform this configuration via the Management Portal, as noted abo ve.)

The class also provides the List() class query.

The class documentation includes examples and details.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure global mappings.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

GUIDs (Globally Unique Identifiers) (Tools/APIs)

Work with GUIDs (Globally Unique Identifiers).

A GUID (globally unique identifier) is a unique reference number used as an identifier

.

GUIDENABLED class parameter

Enables you to generate a GUID for each instance of the class. See Object Synchronization.

%ExtentMgr.GUID class

This class is a persistent class that gives you access to GUID,OID value pairs. This class can be queried using SQL. This class presents examples.

%GUID class

Provides utility methods for GUIDs. These include:

• %FindGUID()

• AssignGUID()

• And others

Includes the following method:

• CreateGUID()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

HTTP (Tools/APIs)

HTTP (Tools/APIs)

Send and receive HTTP requests and responses.

HTTP (Hypertext Transfer Protocol) is an application protocol used widely on the Internet.

%Net.HttpRequest and %Net.HttpResponse classes

Enable you to send HTTP requests and receive HTTP responses.

For details and examples, see Using Internet Utilities. The class reference for %Net.HttpRequest is also quite detailed.

HTTP adapters

Provide an HTTP listener for custom port listening, XML listening, or raw HTML handling. The adapters support the standard HTTP operations Post, Get, and Put, and they allow the use of proxy servers. See Using HTTP Adapters in Productions.

These adapters are included automatically in many specialized business host classes.

Availability: All interoperability-enabled namespaces.

Healthcare Data (Tools/APIs)

Process healthcare data.

Details InterSystems IRIS for Health™ and HealthShare® Health Connect both provide tools for working with numerous healthcare data formats, listed elsewhere. InterSystems IRIS® data platform does not include these features.

Importing Data (Tools/APIs)

Importing Data (Tools/APIs)

Import data programmatically.

The Management Portal provides two generic options for importing data:

• The Data Import Wizard, which imports data into SQL tables. See Importing Data from a Text File.

• The Import Globals page, which imports globals from .gof files. See Importing Globals.

You can also import data from .txt files or command also enables you to import data from JDBC sources by using a SQL Gateway Connection.

.csv files into SQL tables by using the LOAD DATA SQL command. This

%SQL.Import.Mgr class

Enables you to import text files into SQL tables. F or information, see %SQL.ExImData, the utility class from which %SQL.Import.Mgr inherits.

%SQL.Migration.Import class

Enables you to import objects from relational databases. It includes support for data scrubbing.

%SQL.Util.Procedures class

Provides the following methods, which you can use to import from CSV files:

• CSV()

• CSVTOCLASS() %Global class Includes the Import() class method

Numerous tools within InterSystems IRIS® data platform provide more specific import options, documented else where.

• SQL Include Files (Tools/APIs) Export include files programmatically .

An include file contains definitions for ObjectScript macros. See Using Macros and Include Files.

Includes the following class methods that you can use with include files:

• Export()

• ExportToStream()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Installation (Tools/APIs)

Installation (Tools/APIs)

Create custom installers.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure databases and namespaces.

ObjectScript utility for unattended installation (Windows)

Enables you to perform unattended custom installation, upgrade, reinstallation (repair), and removal (uninstall) of instances of InterSystems IRIS® data platform on your computer.

Support for extending the InterSystems IRIS distribution (on UNIX®)

Enables you to add a UNIX® install package to an existing InterSystems IRIS distribution.

For information on all these tools, see the Installation Guide.

Inventory Facility (Tools/APIs)

Create a catalog of your code.

The Inventory facility is provided to enumerate and catalog the file and routine components of an InterSystems IRIS® system.

Inventory package

Enables you to create a catalog of your code. Inventory.Scan is a persistent class that represents the results of scanning the installation and examining its components. Other persistent classes contain additional details.

Inventory.Scanner is a utility class for initializing and manipulating inventory scans.

In advanced cases, you can customize this system to scan your own new kinds of "components" or your application code.

See the class reference for these classes and other classes in the Inventory package.

IP Addresses (Tools/APIs)

IP Addresses (Tools/APIs)

Work with IP addresses (validate, get IP addresses, and so on).

InterSystems IRIS® data platform always accepts IPv4 addresses and DNS forms of addressing (host names, with or without domain qualifiers). You can configure InterSystems IRIS to also accept IPv6 addresses; see IPv6 Support.

%NetworkAddress class

Datatype class that validates IP addresses and ports in the format IP|Port. The IP address can either be an IPV4, IPV6, or DNS name.

%Function class

Provides the IPAddresses() method, which returns the IP addresses for a given host.

%SYSTEM.INetInfo class

Provides an interface for Internet address manipulation. These interfaces support both IPV6 and IPV4 Internet addresses. Includes the following class methods:

• BinaryAddrToText()

• CheckAddressExist()

• CheckSubnetMatch()

• GetInterfacesInfo()

• OSsupportsIPV6()

• And others

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

JMS (Tools/APIs)

Produce and consume messages using a Java Messaging Service (JMS).

Java Message Service (JMS) is a messaging standard that allows application components based on the Java Platform Enterprise Edition (Java EE) to create, send, receive, and read messages. It enables distributed communication that is loosely coupled, reliable, and asynchronous.

JMS Adapters

Produce and consume messages using a Java Messaging Service (JMS) from a production.

See External Messaging Platforms.

Availability: All interoperability-enabled namespaces.

JMS Messaging API

Produce and consume messages using a Java Messaging Service (JMS).

See Using the JMS Messaging API.

JSON (Tools/APIs)

JSON (Tools/APIs)

Create, use, and modify JSON-format objects and arrays; serialize objects as JSON; create objects from JSON.

JSON (JavaScript Object Notation) is a lightweight, human-readable data interchange format, described by RFC 7159 and ECMA-404. It is commonly used in client-server communications.

dynamic object and dynamic array classes

A dynamic object is a special kind of InterSystems IRIS® data platform object that has no schema. Instead, such an object is empty, and you can create properties simply by using assignment statements. A dynamic array is similar.

Dynamic objects and arrays are defined by three classes: %DynamicObject, %DynamicArray, and %DynamicAbstractObject (the common superclass).

These classes provide methods to serialize themselves to and from JSON. For details, see Using JSON.

dynamic object and dynamic array expressions

ObjectScript provides support for JSON-format object and array expressions, which return instances of %DynamicObject and %DynamicArray, respectively. For details, see Using JSON.

Kafka (Tools/APIs)

Send and receive Kafka messages.

Kafka is an external messaging platform.

Kafka adapters

Send and receive Kafka messages from within a production.

See Using External Messaging Platforms from Within Productions.

Availability: All interoperability-enabled namespaces.

Kafka Messaging API

Send and receive Kafka messages.

See Using the Kafka External Messaging API.

LDAP (Tools/APIs)

LDAP (Tools/APIs)

Interact with an LDAP database programmatically.

LDAP (Lightweight Directory Access Protocol) is an application protocol for accessing and maintaining distributed directory information services, including user information, which can be used for authentication.

You can configure InterSystems IRIS® data platform to use LD AP authentication; see LDAP Guide.

For more complex authentication requirements, InterSystems provides the following tools:

%SYS.LDAP class

Enables you to interface with an LDAP database. It provides methods you can use for authentication and for working with entries in the LDAP database.

See %SYS.LDAP.

LDAP Outbound adapter

Sends requests to an LDAP server and receives responses.

See EnsLib.LDAP.Adapter.Outbound.

Availability: All interoperability-enabled namespaces.

Licenses (Tools/APIs)

Access information about license usage programmatically; configure license serv ers.

See Managing InterSystems IRIS Licensing.

%SYSTEM.License class

Provides an interface to the InterSystems IRIS® data platform license API. This class provides methods like the following:

• ConnectionCount()

• GetFeature()

• GetKeyStatus()

• GetUserLimit()

• And others It also provides extensive class documentation.

Config.LicenseServers class

Enables you to modify and obtain information about the [LicenseServers] section of the CPF. (Note that you usually modify this file via the Management Portal. See Managing InterSystems Licensing.)

The class also provides the List() class query.

The class documentation includes examples and details.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Locks (Tools/APIs)

Locks (Tools/APIs)

Read lock table information programmatically; remove locks; query and adjust lock table parameters.

An important feature of any multi-process system is concurrency control, the ability to prevent different processes from changing a specific element of data at the same time, resulting in corruption. Thus ObjectScript and InterSystems SQL each provide commands for working with locks, which you use for concurrency control.

The %Persistent class provides a way to control concurrent access to objects, namely, the concurrency argument to %OpenId() and other methods of this class. These methods ultimately use the ObjectScript LOCK command. All persistent objects inherit these methods.

Internally, the in-memory lock table contains the current locks, along with information about the processes that hold those locks. You can use the Management Portal to view the lock table and (if necessary) remove locks; see Monitoring Locks.

For more information on locks, see Locking and Concurrency Control.

In addition, InterSystems provides the following tools:

^$LOCK

This structured system variable returns information about locks.

^LOCKTAB routine

Enables you to view and remove locks. See Managing the Lock Table.

%SYS.LockQuery class

Enables you to read lock table information. This class provides details and examples.

SYS.Lock class

Enables you to remove locks. Also enables you to query and adjust lock table parameters. This class provides methods like the following:

• DeleteOneLock()

• GetLockSpaceInfo()

• SetMaxLockTableSize()

• And others

Important:

Rather than removing a lock, the best practice is to identify and then terminate the process that created the lock. Removing a lock can have a severe impact on the system, depending on the purpose of the lock.

• Concurrency Mode

Macros (Tools/APIs)

Macros (Tools/APIs)

Export macros programmatically; print information about available macros.

A macro defines a substitution in a line of ObjectScript code. F or details, see Using Macros and Include Files.

Includes the following class methods that you can use with macros:

• Export()

• ExportToStream()

• ShowMacros()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Memory (Tools/APIs)

Modify the memory settings programmatically.

You typically modify memory settings via the Management Portal. See Configuring System Information and Advanced Memory Settings.

%SYSTEM.Config class

Includes the following methods:

• ModifyZFSize()

• ModifyZFString()

• Modifybbsiz()

• Modifynetjob()

%SYSTEM.Config.SharedMemoryHeap class

Provides methods related to shared memory heap (gmheap), including these:

• FreeCount()

• GetUsageSummary()

• And others It also provides a couple of class queries.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

messages.log (Tools/APIs)

messages.log (Tools/APIs)

Write to the messages.log file, the operator messages log.

InterSystems IRIS® data platform reports general messages, system errors, certain operating system errors, and network errors through an operator console facility. On Windows, there is no operator console as such and all console messages are sent to the messages.log file in the InterSystems IRIS system manager directory ( install-dir/mgr). For InterSystems IRIS systems on UNIX® platforms, you can send operator console messages to the messages.log file or the console terminal.

For more information, see Monitoring Log Files.

The directory location of this file is configurable in the CPF file; see ConsoleFile.

Provides the WriteToConsoleLog() method, which you can use to write to the messages.log file.

%SYSTEM.Config class

Provides the ModifyConsoleFile() method.

^LOGDMN routine and SYS.LogDmn class

Enable you to set up structured logging, which will write the same messages seen in messages.log to a machinereadable file that can be ingested by your choice of monitoring tool. See Setting Up Structured Logging.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

MIME (Tools/APIs)

Send and receive MIME messages.

MIME (Multipurpose Internet Mail Extensions) is a standard for email and for other content exchanged over the Internet.

%Net.MIMEPart class and other classes in the %Net package

Enable you to create and send MIME messages from within InterSystems IRIS® data platform. For details and examples, see Using Internet Utilities.

• Email MQ (IBM WebSphere MQ) (Tools/APIs) MQ (IBM WebSphere MQ) (Tools/APIs)

Exchange messages between InterSystems IRIS® data platform and IBM WebSphere MQ.

IBM WebSphere MQ is a third-party product for transmitting messages.

%Net.MQSend class and other classes in the %Net package

Define an interf ace to IBM WebSphere MQ, which you can use to exchange messages between InterSystems IRIS and the message queues of IBM WebSphere MQ. For details and examples, see Using Internet Utilities.

MQSeries adapters

Enable a production to receive and send messages in IBM WebSphere MQ (MQ Series) format. Message content can be a specific data type or a binary data stream. The adapters can simply send the message, or send it and then pull the corresponding response from the message queue.

See Using IBM WebSphere MQ Adapters in Productions.

Availability: All interoperability-enabled namespaces.

MQTT (Tools/APIs)

Send and receive Message Queuing Telemetry Transport messages.

Message Queuing Telemetry Transport (MQTT) is a lightweight protocol designed to allow many devices to publish data on the network. It is designed to allow a high message throughput even over networks with limited bandwidth. For more information on MQTT, see MQTT.org.

MQTT adapters

Enable a production to receive and send MQTT messages.

See Using MQTT Adapters in Productions.

Availability: All interoperability-enabled namespaces.

Namespaces (Tools/APIs)

Namespaces (Tools/APIs)

Get information about namespaces programmatically; query for list of namespaces.

In InterSystems IRIS® data platform, any code runs within a namespace. A namespace provides access to data and to code, which is stored (typically) in multiple database files. F or an introduction, see Namespaces and Databases.

Typically you create and configure namespaces via the Management Portal. See Configuring Namespaces.

%SYS.Namespace class

Provides the following class methods:

• Exists()

• GetGlobalDest()

• GetRoutineDest()

This class also provides the following query:

• List()

Includes the following class method:

• NameSpace()

Config.Namespaces class

Enables you to modify and obtain information about the [Namespaces] section of the CPF. (Note that you usually perform this configuration via the Management Portal, as noted abo ve.)

The class also provides the List() class query. The class documentation includes examples and details.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure namespaces.

%Library.EnsembleMgr class

Provides the EnableNamespace() method, which you can use to enable a namespace that supports interoperability productions. You can rerun this method on a namespace that is already enabled for interoperability. You cannot run this method on the %SYS namespace.

For InterSystems health products, however, you must use the Installer Wizard.

Ignore all other methods in this class.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• Databases Operating System (Tools/APIs) Operating System (Tools/APIs)

Obtain information about the operating system.

%SYSTEM.Version class

Includes the following class methods:

• GetOS()

• GetPlatform()

• Is64Bits()

• IsBigEndian()

• IsUnicode()

• And others

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Operating System Commands (Tools/APIs)

Invoke operating system commands from within InterSystems IRIS® data platform.

InterSystems Callout interface

Enables you to invoke executables, operating system commands, and custom written dynamic link libraries from within InterSystems IRIS. See Using the Callout Gateway.

Pipe adapters

Enable a production to execute a shell command and communicate with it via pipes. Capable of handling character data or a binary data stream.

See EnsLib.Pipe.InboundAdapter and EnsLib.Pipe.OutboundAdapter.

Availability: All interoperability-enabled namespaces.

Packages (Tools/APIs)

Packages (Tools/APIs)

Work with packages programmatically (compile, export, delete, and so on); configure mappings.

A package is the initial part of a full class name. Packages group related classes so that you can more easily avoid name conflicts; there are other benefits as well. F or more information, see Packages.

You can define package mappings so that you can access code in a non-default location; see Configuring Namespaces. Typically you do this within the Management Portal.

Provides the following methods that you can use with packages:

• CompilePackage()

• DeletePackage()

• Export()

• ExportJavaPackage()

• ExportPackage()

• ExportPackageToStream()

• ExportToStream()

• GetPackageList()

%Studio.Package class

Represents the package information used by the class compiler. This class provides the following methods:

• Exists()

• LockItem()

Config.MapPackages class

Enables you to modify and obtain information about the [Map.xxx] section of the CPF, which defines package mappings. (Note that you usually perform this configuration via the Management Portal, as noted abo ve.)

The class also provides the List() and ListPackages() class queries.

The class documentation includes examples and details.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure package mappings.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Get information about and manipulate CPU processes (also known as jobs).

A CPU process is an instance of an InterSystems IRIS® data platform virtual machine running on an InterSystems IRIS server. Every active process has a unique job number. You typically use the Management Portal to view the process list and, if necessary, suspend, resume, or terminate them; see Controlling InterSystems IRIS Processes.

Note: Within productions, a CPU process is called a job, to avoid confusion with the term business processes, which

are frequently referred to simply as processes.

^$JOB

This structured system variable returns information about processes.

%SYSTEM.Process class

Allows manipulation and display of the current process. This class provides class methods like the following:

• BatchFlag()

• CallingRoutine()

• ExceptionLog()

• GetCPUTime()

• NodeNameInPid()

• PrivateGlobalLocation()

• TruncateOverflo w()

• And others Some of the class methods have restrictions on where they may be called.

Provides the following class methods:

• ProcessID()

• MaxLocalLength()

Provides the following class methods:

• JobPrio()

• GetPrio()

• SetPrio()

%SYS.ProcessQuery class

Enables you to display and manipulate InterSystems IRIS processes. This class provides properties that you can set to modify a process, as well as read-only properties that provide information about its current state. Properties of this class include:

• ClientExecutableName

• CurrentDevice

• JobType

• LastGlobalReference

• Priority

• Routine

• UserName

• And others

It also provides the following class methods:

• GetCPUTime()

• KillAllPrivateGlobals()

• NextProcess()

• And others

It also provides queries, which include:

• AllFields()

• CONTROLPANEL()

• JOBEXAM()

• And others

SYS.Process class

Provides instance methods which operate on a process instance as well as class methods for use by managers. This class provides the following methods:

• ProcessTableSize()

• ReleaseAllLocks()

• Resume()

• Suspend()

• Terminate() This class extends %SYS.ProcessQuery and thus also includes the properties, methods, and queries of that class.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Productions (Tools/APIs)

(Production-enabled namespaces) Work with productions programmatically (start, check status, enable configuration items, stop, and so on).

A production is a specialized package of software and documentation that solves a specific inte gration problem for an enterprise customer. See Developing Productions.

You create and compile productions in the Management Portal (or in your IDE). Typically you also start, configure, and stop productions in the Management Portal.

Ens.Director class

Provides a large set of methods that you can use to start, stop, and otherwise control productions programmatically. These methods include:

• EnableConfigItem()

• GetHostSettings()

• GetProductionStatus()

• ProductionNeedsUpdate()

• StartProduction()

• And others Availability: All interoperability-enabled namespaces.

%SYS.Ensemble class

Provides the following methods for working with productions:

• CreateDocumentation()

• GetEnsMetrics()

• StartProduction()

• StopProduction()

Python (Tools/APIs)

Python (Tools/APIs)

InterSystems IRIS® data platform gives you options to use Python in different ways, depending on your needs.

Embedded Python Embedded Python allows you to use Python as a fully supported alternative to InterSystems ObjectScript for creating InterSystems IRIS applications. When you write code in Embedded Python, it is compiled into object code that is interchangeable with compiled ObjectScript code. This allows for tighter integration than is possible with the InterSystems Python External Server or the Native SDK for Python.

The Python External Server The Python External Server allows your ObjectScript code to generate a proxy object that controls a corresponding Python target object. You can then access methods and properties just as if you were using the Python object directly.

The Native SDK for Python The Native SDK for Python is a lightweight interface that allows you to access many InterSystems IRIS features directly from your Python application. You can:

• Call ObjectScript class methods or functions from your Python application as easily as you can call native Python methods.

• Generate a proxy object in your Python application that creates and controls an ObjectScript object on the server. The Python proxy can call instance methods and get or set properties just as if you were using the server object directly.

• Work with multidimensional global arrays (known in InterSystems IRIS simply as globals). You can create, read, change, and delete globals just as if you were using ObjectScript.

The Production EXtension (PEX) The Production EXtension (PEX) framework allows you to use Python to develop custom components of an interoperability production, including adapters and business hosts. For productions, PEX is the standard way to interoperate with Python.

The Python ODBC Bridge (pyodbc) The Python ODBC Bridge (pyodbc) allows you to use ODBC to connect to InterSystems IRIS by implementing the DB API 2.0 specification ( PEP 249—Python Database API Specification v2.0 ), leveraging ODBC to access the underlying database.

RabbitMQ (Tools/APIs)

Send and receive RabbitMQ messages.

RabbitMQ is a message broker that supports multiple open standard protocols. The InterSystems IRIS® data platform APIs specifically w ork with the RabbitMQ implementation of the AMQP 0–9–1 protocol.

RabbitMQ Adapters

Send and receive RabbitMQ messages from a production.

See External Messaging Platforms.

Availability: All interoperability-enabled namespaces.

JMS Messaging API

Send and receive RabbitMQ messages.

See Using the RabbitMQ Messaging API.

Regular Expressions (Tools/APIs)

Regular Expressions (Tools/APIs)

Perform pattern matching using regular expressions.

Regular expressions are a short and fle xible way to match strings, so that you can locate particular characters, words, or patterns of characters.

$LOCATE ObjectScript function

Returns the position of the first match of a re gular expression in a string. See $LOCATE and Regular Expressions.

$MATCH ObjectScript function

Returns a boolean value depending on whether a string matches a regular expression. See $MATCH and Regular Expressions.

%Regex.Matcher class

Creates an object that does pattern matching using regular expressions. The regular expressions come from the International Components for Unicode (ICU). The ICU maintains web pages at http://www.icu-project.org.

For details, see Regular Expressions.

Notes The ObjectScript pattern matching operator is also quite fle xible, but does not provide the full range of syntax given by regular expressions. See the Pattern Matching reference page.

Routines (Tools/APIs)

Work with routines programmatically (create, compile, get time stamp, export, and so on); configure mappings.

You can create routines in ObjectScript. For information, see:

• Orientation Guide for Server-Side Programming

• Using ObjectScript

You can define routine mappings so that you can access code in a non-default location; see Configuring Namespaces. Typically you do this within the Management Portal.

^$ROUTINE

This structured system variable returns information about routines.

%Routine class

Enables you to read, create, manipulate, save, and compile routines. This class provides methods such as the fol- lowing:

• CheckProtect()

• CheckSyntax()

• Compile()

• GetCurrentTimeStamp()

• Lock()

• Rewind()

• RoutineExists()

• And others

It also provides the following queries:

• Compare()

• Find()

• RoutineList()

• RoutineSortByField() %RoutineIndex class Index for all the routines in this namespace.

Includes the following class methods that you can use with routines:

Routines (Tools/APIs)

• CompileList()

• Export()

• ExportToStream()

• Load()

Config.MapRoutines class

Enables you to modify and obtain information about the [Map.xxx] section of the CPF, which defines routine mappings. (Note that you usually perform this configuration via the Management Portal, as noted abo ve.)

The class also provides the List() class query.

The class documentation includes examples and details.

configuration merge

The configuration mer ge feature lets you make as many changes as you wish to the configuration of an y InterSystems IRIS® instance in a single operation. See Introduction to Configuration Mer ge.

%Installer.Manifest class and other classes in the %Installer package

Enable you to define and use an installation manifest. Among other tasks, you can configure routine mappings.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

SASL (Tools/APIs)

Implement SASL to include authentication in connection-based protocols.

SASL is the Simple Authentication and Security Layer as defined by RFC 2222. It is a method for adding authentication support to connection-based protocols.

%Net.Authenticator class

Implements SASL. This class will pick a security mechanism (e.g. CRAM-MD5) from a list defined by the user of this class based on server options. The selected security mechanism will use its challenge-response mechanism to authenticate this client with the selected server.

%Net.SASL package

Implements security mechanisms for SASL for use with the preceding class. For example, %Net.SASL.CRAMMD5 implements the CRAM-MD5 SASL mechanism.

Security Items (Tools/APIs)

Security Items (Tools/APIs)

Work with roles, resources, applications, TLS configurations, and other security items programmatically (create, manipulate, export, and so on).

For an introduction to security in InterSystems IRIS® data platform, see About InterSystems Security.

Typically you create and modify security items via the Management Portal.

%SYSTEM.Security class

Provides security-related utility methods. These are as follows:

• AddRoles()

• Audit()

• ChangePassword()

• Check()

• GetGlobalPermission()

• Login()

• ValidatePassword() Security package Provides classes you can use to define and manipulate security items programmatically . Typically, you would use these to define resources, roles, and possibly starter user IDs as part of installation. Classes in this package include:

• Security.Applications

• Security.Events

• Security.Resources

• Security.SQLPrivileges

• Security.SSLConfigs

• And others Security routines InterSystems provides several routines that you can use as an alternative to the Management Portal. See Command- Line Security Management Utilities.

Availability: Most are available only in the %SYS namespace.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• Auditing

Server (Tools/APIs)

Server (Tools/APIs)

Obtain information about the InterSystems IRIS® data platform server and its environment.

InterSystems IRIS is an application server, which works in conjunction with a web server and with the Web Gateway. For information on the Web Gateway and on supported web servers, see Introduction to the Web Gateway.

This topic discusses the application server, as opposed to the third-party web server.

Provides methods like the following:

• GetInstanceName()

• GetUniqueInstanceName()

• GetNodeName()

• TempDirectory()

• And others

Provides methods like the following:

• BinaryDirectory()

• InstallDirectory()

• ManagerDirectory()

• And others

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

SQL (Tools/APIs)

Use SQL within InterSystems IRIS® data platform; access third-party ODBC- or JDBC-compliant databases; access InterSystems IRIS as an ODBC- or JDBC-compliant database.

Background SQL (Structured Query Language) is a programming language designed for managing data in relational database management systems (RDBMS).

InterSystems SQL

InterSystems IRIS provides an implementation of SQL, known as InterSystems SQL, which you can use within various programmatic contexts.

Also, you can execute InterSystems SQL directly within the SQL Shell (in the Terminal) and in the Management Portal. Each of these includes an option to view the query plan, which can help you identify ways to make a query more efficient.

For an introduction, see Using InterSystems SQL.

For reference information, see the InterSystems SQL Reference.

%SYSTEM.SQL class and classes in the %SYSTEM.SQL package

Includes methods related to InterSystems SQL. These include methods that do the following tasks:

• Implement SQL functions

• Check SQL privileges

• Purge cached queries

• Access the %ROWID and SQLCODE variables

• Import DDL files

• Launch SQL shells

• Modify SQL configuration settings

• Modify SQL Gateway connections

• And others

%SQL.Migration.Util class

Provides utilities for SQL migration. This class provides methods like the following;

• CopyOneView()

• DSNFetch()

• DropTable()

• ExecSql()

SQL (Tools/APIs)

• And others It also provides several class queries.

InterSystems SQL Gateway

Enables your applications to access third-party relational databases (via ODBC or JDBC). Using the SQL Gateway, applications can:

• Access data stored in third-party relational databases within InterSystems IRIS applications using objects and/or SQL queries.

• Store persistent InterSystems IRIS objects in external relational databases.

For details, see Using the InterSystems SQL Gateway.

InterSystems ODBC driver

Enables you to access InterSystems IRIS as a ODBC-compliant database. See Using the InterSystems ODBC Driver.

InterSystems JDBC driver

Enables you to access InterSystems IRIS as a JDBC-compliant database. See Using Java with the InterSystems JDBC Driver.

Config.SQL, Config.SqlSysDatatypes, and Config.SqlUserDatatypes classes

Enable you to modify and obtain information about the [SQL], [SqlSysDatatypes], and [SqlUserDatatypes] sections of the CPF. (Note that you usually modify this file via the Management Portal. See the [SQL] section of Configuration Parameter Reference File.)

Config.SqlSysDatatypes and Config.SqlUserDatatypes each provide the List() class query.

The class documentation includes examples and details.

SQL Adapters

Enable productions to execute SQL statements against a remote database via an ODBC-defined or JDBC-defined Data Source Name (DSN). See Using SQL Adapters in Productions.

Availability: All interoperability-enabled namespaces.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

• DDL Files

• SQL Gateway Connections SQL Gateway Connections (Tools/APIs) SQL Gateway Connections (Tools/APIs)

Manage and access SQL Gateway connections programmatically (check connections, query by name, and so on).

The SQL Gateway allows InterSystems IRIS® data platform to access external databases via both JDBC and ODBC. For a detailed description of the SQL Gateway, see Using the InterSystems SQL Gateway.

An SQL Gateway connection contains information about accessing a specific e xternal database via JDBC or via ODBC. You generally define these connections in the Management Portal.

%SYSTEM.SQLGateway class

Provides an interface for managing SQL Gateway connections. This class provides methods like the following:

• DropConnection()

• GetJDBCConnection()

• GetODBCConnection()

• Test()

• And others

%SYSTEM.SQL.Util class

Provides an interface for managing SQL gateways and SQL options. This class provides methods like the following:

• CloseAllGateways()

• GetOption()

• SetOption()

• And others %SQLConnection class

Stores SQL Gateway connections. This class provides the following methods:

• ConnExists()

• setEncode()

It also provides the following class queries:

• ByConnection()

• ByName()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

SSH (Tools/APIs)

SSH (Tools/APIs)

Use SSH to communicate securely.

SSH (Secure Shell) is a network protocol for secure communication over a network.

It is more common to use TLS, however.

%Net.SSH.Session and %Net.SSH.SFTP classes

Enable you to communicate securely via SSH. You can perform SCP (Secure Copy) operations of single files to and from the remote system. You can also execute remote commands, tunnel TCP traffic, and perform SFTP operations.

See Using SSH

Startup and Shutdown Behavior (Tools/APIs)

Customize startup and shutdown behavior.

Startup and shutdown behavior is a broad topic. The following list indicates tools you can use to programmatically customize startup and shutdown behavior of the system as a whole:

Config.Startup class

Enables you to modify and access information about the [Startup] section of the CPF. (Note that you usually modify this file via the Management Portal. See Memory and Startup Settings.)

The class documentation includes examples and details.

^ZWELCOME routine

InterSystems reserves this routine name for your use; the routine is not predefined. The ^ZWELCOME routine is intended to contain custom code to execute when the Terminal starts. See Using the ObjectScript Shell.

Availability: Affects only the namespace in which it is defined (by def ault).

^%ZSTART routine

InterSystems reserves this routine name for your use; the routine is not predefined. The ^%ZSTART routine is intended to contain custom code to execute when certain events happen, such as when a user logs in. If you define this routine, the system calls it when these events happen. See Customizing Start and Stop Behavior with ^%ZSTART and ^%ZSTOP Routines.

Availability: Affects all namespaces.

^%ZSTOP routine

InterSystems reserves this routine name for your use; the routine is not predefined. The ^%ZSTOP routine is intended to contain custom code to execute when certain events happen. See the comments for ^%ZSTART.

Availability: Affects all namespaces.

In addition, many classes that you use provide callback methods that enable you to customize startup and shutdown behavior of the code. For example, you can customize callback methods to control startup and shutdown behavior of productions.

Tasks (Tools/APIs)

Tasks (Tools/APIs)

Work with tasks (Task Manager) programmatically (schedule, export definitions, query , and so on).

A task is a unit of work that you schedule via the Task Manager; see Using the Task Manager.

%SYS.Task class and classes in the %SYS.Task package

These classes define an API to schedule tasks to run in the background. They include methods like the following:

• AssignSettings()

• ExportTasks()

• Resume()

• RunNow()

• And others

They also inherits class queries from the %SYS.TaskSuper class, such as:

• QuickTaskList()

• SuspendedTasks()

• TaskList()

• And others

TCP/IP (Tools/APIs)

Communicate via TCP/IP; work with TCP devices.

TCP/IP is the common name for a suite of protocols for the Internet and other networks. TCP (Transmission Control Protocol) and IP (Internet Protocol) are the two original components of this suite.

InterSystems IRIS TCP binding

Enables you to set up communication between InterSystems IRIS® data platform processes using TCP/IP. See the I/O Device Guide.

%SYSTEM.INetInfo class

Includes the following methods:

• TCPName()

• TCPStats()

%SYSTEM.Socket class

Provides an interface for multiplexing TCP devices. The reference information for this class includes examples.

%SYSTEM.TCPDevice class

Provides an interface for retrieving the IP address and port of current InterSystems IRIS TCP device.

TCP adapters

Enable a production to manage an incoming or outgoing TCP connection. The adapters allow simultaneous handling of multiple connections. They support character and binary data streams, and counted data blocks.

See Using TCP Adapters in Productions.

The TCP adapters are also built into many specialized production classes.

Availability: All interoperability-enabled namespaces.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Telnet (Tools/APIs)

Telnet (Tools/APIs)

Use Telnet from within InterSystems IRIS® data platform.

Telnet is a network protocol used on the Internet or in some networks. The term Telnet also refers to client software that uses this protocol.

%Net.TelnetStream class

Emulates the handshaking behavior of Windows Telnet.exe.

See %Net.TelnetStream.

Config.Telnet class

Enables you to modify and access information about the [Telnet] section of the CPF. (Note that you usually modify this file via the Management Portal. See the [T elnet] section in Configuration P arameter Reference File.)

For this class, the class reference provides extensive details and an example.

Telnet adapter

Enable a production to initiate and manage a Telnet connection.

See EnsLib.Telnet.OutboundAdapter.

Availability: All interoperability-enabled namespaces.

TLS (Tools/APIs)

Use TLS to communicate securely; obtain information about TLS connection in use.

Transport Layer Security (TLS) and its predecessor, Secure Sockets Layer (SSL), are cryptographic protocols that provide communication security over the Internet. (InterSystems sometimes uses the term SSL/TLS to refer to TLS.)

SSL/TLS configurations

InterSystems IRIS® data platform supports the ability to store a TLS configuration and specify an associated name. When you need a TLS connection (for HTTP communications, for example), you provide the applicable configuration name, and InterSystems IRIS automatically handles the TLS connection.

See InterSystems TLS Guide.

Configurations are stored in the Security.SSLConfigs class, which provides an object-based API; this class cannot be accessed via SQL.

%SYSTEM.Security.Users class

Provides methods that you can use to get information about the TLS connection in use on the principal device, if any. These methods include:

• SSLGetCipher()

• SSLGetCipherList()

• SSLGetLastError()

• SSLGetPeerCertificate()

• SSLGetPeerName()

• SSLGetProtocol()

• SSLPeekClientHello()

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

UDDI (Tools/APIs)

UDDI (Tools/APIs)

(Production-enabled namespaces) Use UDDI to work with web services.

UDDI (Universal Description, Discovery, and Integration) is a XML-based registry for web services. It is an open industry initiative, sponsored by the Organization for the Advancement of Structured Information Standards (OASIS).

EnsLib.UDDI package

Provides classes that represent an interface to a UDDI server. For example, EnsLib.UDDI.Connection represents a connection to a UDDI server.

Availability: All interoperability-enabled namespaces.

URLs (Tools/APIs)

Parse a URL into its component parts.

%Net.URLParser class

Provides the Compose() and Decompose() methods.

Version (Tools/APIs)

Version (Tools/APIs)

Obtain information about the system version.

ObjectScript provides a special variable ($ZVERSION) that you can use to obtain version information for InterSystems IRIS® data platform. Note that $ZVERSION is available within SQL queries (as are other special variables).

%SYSTEM.Version class

Provides methods like the following:

• GetComponents()

• GetBuildNumber()

• GetPlatform()

• GetProduct()

• GetVersion()

• And others

%ZHSLIB.HealthShareMgr class

Provides the VersionInfo() method, which displays information on HealthShare product versions.

Availability: All namespaces in a HealthShare instance.

Note The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

Web Gateway (Tools/APIs)

Manage the Web Gateway programmatically.

The Web Gateway serves requests to REST services defined in InterSystems IRIS® data platform. It is a DLL or shared library installed on and loaded by the web server.

Usually you configure and manage the Web Gateway via the Web Gateway Management page; see the Web Gateway Guide.

%CSP.Mgr.GatewayMgr class

Defines an API used to control a Web Gateway from InterSystems IRIS code. Its methods provide the infrastructure for accessing (and modifying) the Web Gateway's internal tables, configuration, and log files from participating servers. Methods in this class include:

• ClearCache()

• CloseConnections()

• GetCSPIni()

• GetInfo()

• GetSystemStatus()

• SetServerParams()

• And others You must have specific permissions to use these methods.

%CSP.Mgr.GatewayRegistry class

Is a registry of Web Gateways managed by InterSystems IRIS. This class provides the following methods:

• GetGatewayMgrs()

• RemoveFilesFromCaches() You must have specific permissions to use these methods.

X12 (Tools/APIs)

X12 (Tools/APIs)

(Production-enabled namespaces) Receive, work with, and send X12 documents.

X12 is the ANSI standard for Electronic Data Interchange (EDI). There are more than 300 document types defined within this standard.

X12 support in productions

InterSystems IRIS® data platform provides classes that enable productions to receive, work with, and send X12 documents as virtual documents. See Routing X12 Documents in Productions.

Availability: All interoperability-enabled namespaces.

X.509 Certificates (Tools/APIs)

Use X.509 certificates.

X.509 is a standard that defines elements that can be used for encryption, digital signatures, decryption, and v erifying digital signatures. These elements include public keys and X.509 certificates.

X.509 certificate storage

InterSystems IRIS® data platform supports the ability to load an X.509 certificate and pri vate key and specify an associated configuration name. When you need an X.509 certificate (to digitally sign a SO AP message, for example), you provide the applicable configuration name, and InterSystems IRIS automatically e xtracts and uses the certificate information.

You can optionally enter the password for the associated private key file, or you can specify this at runtime.

Configurations are stored in the %SYS.X509Credentials class, which provides an object-based API; this class cannot be accessed via SQL.

Access to a certificate authority (CA)

If you place a CA certificate of the appropriate format in the prescribed location, InterSystems IRIS uses it to validate digital signatures and so on.

Both items are discussed in Securing Web Services and Using XML Tools.