Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

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, Studio, 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.

  • .NET – Interoperate with .NET clients and objects.
  • ActiveX/COM – Interoperate with ActiveX/COM clients and objects.
  • Applications – Work with web applications, privileged routine applications, and client applications (create, modify, export, and so on).
  • Archiving – Archive files to an archive server.
  • Arrays – Work with arrays.
  • ASTM – (Ensemble) Receive, work with, and send ASTM documents from clinical instruments.
  • Auditing – Add entries to the audit log.
  • Authentication – Authenticate users.
  • Authorization – Control what each user is permitted to use, view, or alter.
  • Basic – Write routines and methods in an implementation of Basic.
  • Bitstrings – Convert strings to bitstrings.
  • Business Intelligence – Analyze data; develop a measurement-based approach to making strategic and tactical decisions.
  • Business Logic – (Ensemble) Model business rules and processes within an Ensemble production.
  • C – Access Caché from C programs.
  • C++ – Access Caché from C++ programs.
  • cconsole.log – Write to the cconsole.log file, the operator console log.
  • 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 File – Modify the CPF file programmatically (create databases, define mappings, configure devices, and so on).
  • CPUs (Processors) – Obtain information about CPUs (processors).
  • CSP Gateway – Manage a CSP Gateway programmatically.
  • CSV Files – Work with CSV (comma-separated values) data sources.
  • Current Date and Time – Obtain the current date and time.
  • Custom Language Elements – Add custom commands, functions, and special variables to ObjectScript, Caché MVBasic, or Caché Basic.
  • Custom Metrics – Define custom metrics.
  • Dashboards – Create dashboards for your end users.
  • Data Synchronization – Keep data synchronized on multiple systems.
  • Data Transformation – (Ensemble) Modify data being sent within an Ensemble production.
  • Data Type Classes – Define properties to contain literal values.
  • Databases – Manage Caché 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.
  • Debugging – Debug programs.
  • Devices – Work programmatically with devices such as printers and tape drives; configure; query for list of devices.
  • DICOM – (Ensemble) Receive, work with, create, and send DICOM documents.
  • Directories and Drives – Work with directories and drives programmatically.
  • DLLs and Executables (Non-InterSystems) – Invoke dynamic link libraries and executables provided by other vendors.
  • DOMs – Work with XML DOMs (document object model).
  • Dynamic SQL – Create SQL statements that are prepared and executed at runtime.
  • ebXML – (Ensemble) Use ebXML messages to interface with other systems.
  • EDIFACT – (Ensemble) Receive, work with, and send EDIFACT documents.
  • 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.
  • FileMan – Convert FileMan files into Caché classes.
  • Files – Work with files programmatically (read, write, copy, rename, and so on).
  • FTP – Use FTP from within Caché.
  • Full-Text Searching – Perform full-text searching.
  • 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).
  • HL7 Messages – (Ensemble) Receive, work with, and send HL7 Version 2 and HL7 Version 3 messages.
  • HTML – Parse HTML (Ensemble).
  • 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).
  • ISQL – Migrate from ISQL.
  • Java – Interoperate with Java programs.
  • JDBC – Access third-party JDBC-compliant databases from within Caché; access Caché as an JDBC-compliant database.
  • 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 Caché license usage programmatically; configure license servers.
  • Lists – Work with lists.
  • Locks – Read lock table information programmatically; remove locks; query and adjust lock table parameters.
  • Macros – Export macros programmatically; print information about available macros.
  • MDX – Create and execute MDX queries.
  • Memory – Modify the memory settings programmatically.
  • MIME – Send and receive MIME messages.
  • MQ (IBM WebSphere MQ) – Exchange messages between Caché and IBM WebSphere MQ.
  • MultiValue – Write routines and methods in MultiValue; access data stored in MultiValue format; generate MVBasic client classes; write to the mv.log file.
  • Namespaces – Get information about Caché namespaces programmatically; query for list of namespaces.
  • Node.js – Use Node.js to implement for high-performance access to data held in Caché databases.
  • Objects – Define objects.
  • ObjectScript – Write routines and methods in ObjectScript.
  • ODBC – Access third-party ODBC-compliant databases from within Caché; access Caché as an JDBC-compliant database.
  • Operating System – Obtain information about the operating system.
  • Operating System Commands – Invoke operating system commands from within Caché.
  • Packages – Work with packages programmatically (compile, export, delete, and so on); configure mappings.
  • Performance Diagnosis – Diagnose performance.
  • Perl – Access Caché from Perl programs.
  • PMML (Predictive Modelling Markup Language) – Execute PMML models.
  • Processes (Jobs) – Get information about and manipulate CPU processes (known as jobs in Ensemble).
  • Productions – (Ensemble) Work with productions programmatically (start, check status, enable configuration items, stop, and so on).
  • Projects – Work with Studio projects programmatically (export, compile, copy, delete, and so on).
  • Publish and Subscribe – (Ensemble) Route messages to subscribers based on their expressed interests.
  • Push Notifications – Send push notification messages to iOS and Google devices.
  • Python – Access Caché from Python programs.
  • Regular Expressions – Perform pattern matching using regular expressions.
  • Reports – Create reports.
  • REST (Web Services and Clients) – Create REST web services and web clients.
  • Routines – Work with routines programmatically (create, compile, get time stamp, export, and so on); configure mappings.
  • SAML Tokens – Add SAML tokens to WS-Security headers.
  • 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 Caché or Ensemble server and its environment.
  • Siebel – (Ensemble) Communicate with a Siebel server.
  • SOAP (Web Services and Clients) – Create SOAP-compliant web services and web clients.
  • Source Control – Connect Studio to your source control system.
  • SQL – Use SQL within Caché; access third-party ODBC- or JDBC-compliant databases; access Caché 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.
  • Status Values – Work with the %Status data type.
  • Streams – Work with streams.
  • Studio – Extend Studio and connect Studio to your version control system.
  • 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 Caché.
  • Testing – Perform automated testing of your code.
  • Transact-SQL – Use Transaction-SQL in Caché.
  • Text-Based User Interfaces – Create text-based user interfaces.
  • UDDI – (Ensemble) Use UDDI to work with web services.
  • Unstructured Data – Work with unstructured data.
  • URLs – Parse a URL into its component parts.
  • User Portal – Provide a user portal for your end users.
  • Version – Obtain information about the system version.
  • Web Pages – Create a front end for your application by creating web pages.
  • Workflow – (Ensemble) Incorporate human interaction into automated business processes.
  • X12 – (Ensemble) Receive, work with, and send X12 documents.
  • X.509 Certificates – Use X.509 certificates.
  • XML – Project objects as XML documents; read, transform, and write XML documents; send and receive XML documents from Ensemble productions; and so on.
  • XPATH – Evaluate XPATH expressions.
  • XSLT – Perform XSLT transformations.
  • XTP (Extreme Transaction Processing) – Implement XTP (Extreme Transaction Processing) using Caché databases.
Feedback