Skip to main content
Previous section

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 in an installation program.

If there is no reference page for the item you seek, see the additional list in the preface to this book.

  • Applications – Work with web applications, privileged routine applications, and client applications (create, modify, export, and so on).
  • Archiving – Archive files to an archive server.
  • Auditing – Add entries to the audit log.
  • Bitstrings – Convert strings to bitstrings.
  • C – Access InterSystems IRIS from C programs.
  • Class Definitions – Work with class definitions and class members programmatically (obtain information about, define, make deployed, and so on).
  • Concurrency Mode – Get and set the concurrency mode for the current process.
  • CPF – Modify the CPF programmatically (change settings such as memory and journal settings, define mappings, configure devices, and so on).
  • CPUs (Processors) – Obtain information about CPUs (processors).
  • CSV Files – Work with CSV (comma-separated values) data sources.
  • Current Date and Time – Obtain the current date and time.
  • Databases – Manage InterSystems IRIS database files programmatically (disable and enable journaling, copy, configure, and so on).
  • Date/Time Values – Work with date/time values.
  • DDL – Work with DDL statements and with DDL files.
  • Devices – Work programmatically with devices such as printers; configure; query for list of devices.
  • Directories and Drives – Work with directories and drives programmatically.
  • Email – Send and receive email programmatically.
  • Encryption – Protect information against unauthorized viewing.
  • Environment Variables – Access the value of an environment variable.
  • Exporting Data – Export data programmatically.
  • Extents – Work with extent definitions programmatically.
  • Files – Work with files programmatically (read, write, copy, rename, and so on).
  • FTP – Use FTP from within InterSystems IRIS.
  • Globals – Manage globals programmatically (import, export, get size, set collation, configure mappings, and so on).
  • GUIDs (Globally Unique Identifiers) – Work with GUIDs (Globally Unique Identifiers).
  • HTTP – Send and receive HTTP requests and responses.
  • Importing Data – Import data programmatically.
  • Include Files – Export include files programmatically.
  • Installation – Create custom installers.
  • Inventory Facility – Create a catalog of your code.
  • IP Addresses – Work with IP addresses (validate, get IP addresses, and so on).
  • JSON – Create, use, and modify JSON-format objects and arrays; serialize objects as JSON; create objects from JSON.
  • LDAP – Interact with an LDAP database programmatically.
  • Licenses – Access information about InterSystems IRIS license usage programmatically; configure license servers.
  • Locks – Read lock table information programmatically; remove locks; query and adjust lock table parameters.
  • Macros – Export macros programmatically; print information about available macros.
  • Memory – Modify the memory settings programmatically.
  • messages.log – Write to the messages.log file, the operator messages log.
  • MIME – Send and receive MIME messages.
  • MQ (IBM WebSphere MQ) – Exchange messages between InterSystems IRIS and IBM WebSphere MQ.
  • Namespaces – Get information about InterSystems IRIS namespaces programmatically; query for list of namespaces.
  • Operating System – Obtain information about the operating system.
  • Operating System Commands – Invoke operating system commands from within InterSystems IRIS.
  • Packages – Work with packages programmatically (compile, export, delete, and so on); configure mappings.
  • Processes (Jobs) – Get information about and manipulate CPU processes (known as jobs in InterSystems IRIS).
  • Productions – (Production-enabled namespaces) Work with productions programmatically (start, check status, enable configuration items, stop, and so on).
  • Regular Expressions – Perform pattern matching using regular expressions.
  • Routines – Work with routines programmatically (create, compile, get time stamp, export, and so on); configure mappings.
  • SASL – Implement SASL to include authentication in connection-based protocols.
  • Security Items – Work with roles, resources, applications, SSL configurations, and other security items programmatically (create, manipulate, export, and so on).
  • Server – Obtain information about the InterSystems IRIS server and its environment.
  • SQL – Use SQL within InterSystems IRIS; access third-party ODBC- or JDBC-compliant databases; access InterSystems IRIS as an ODBC- or JDBC-compliant database.
  • SQL Gateway Connections – Manage and access SQL Gateway connections programmatically (check connections, query by name, and so on).
  • SSH – Use SSH to communicate securely.
  • SSL/TLS – Use SSL/TLS to communicate securely; obtain information about SSL/TLS connection in use.
  • Startup and Shutdown Behavior – Customize startup and shutdown behavior.
  • Tasks – Work with tasks (Task Manager) programmatically (schedule, export definitions, query, and so on).
  • TCP/IP – Communicate via TCP/IP; work with TCP devices.
  • Telnet – Use Telnet from within InterSystems IRIS.
  • UDDI – (Production-enabled namespaces) Use UDDI to work with web services.
  • URLs – Parse a URL into its component parts.
  • Version – Obtain information about the system version.
  • Web Gateway – Manage the Web Gateway programmatically.
  • X12 – (Production-enabled namespaces) Receive, work with, and send X12 documents.
  • X.509 Certificates – Use X.509 certificates.