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, 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 – ActiveXCOMInteroperate with ActiveX/COM clients and objects.
  • Applications – Work with web applications, privileged routine applications, and client applications (create, modify, export, and so on).
  • Archiving – archivearchive serverCenteraEMC CenteraArchive files to an archive server.
  • Arrays – arrayWork with arrays.
  • ASTM – (Ensemble) Receive, work with, and send ASTM documents from clinical instruments.
  • Auditing – auditAdd 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 – bitstringConvert strings to bitstrings.
  • Business Intelligence – BIAnalyze 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 – console logWrite to the cconsole.log file, the operator console log.
  • Class Definitions – classclassesclass memberclass membersclass definitionWork with class definitions and class members programmatically (obtain information about, define, make deployed, and so on).
  • Concurrency Mode – concurrencyGet and set the concurrency mode for the current process.
  • CPF File – CPFModify the CPF file programmatically (create databases, define mappings, configure devices, and so on).
  • CPUs (Processors) – CPUCPUsprocessorprocessorsObtain information about CPUs (processors).
  • CSP Gateway – Manage a CSP Gateway programmatically.
  • CSV Files – CSVCSV fileWork with CSV (comma-separated values) data sources.
  • Current Date and Time – nowsystem timecurrent datecurrent timesystem datesystem timeObtain the current date and time.
  • Custom Language Elements – custom commandcustom commandscustom variablecustom variablescustom functioncustom functionsAdd custom commands, functions, and special variables to ObjectScript, Caché MVBasic, or Caché Basic.
  • Custom Metrics – custom metricmetricmetricsbusiness metricbusiness metricsDefine custom metrics.
  • Dashboards – dashboardCreate dashboards for your end users.
  • Data Synchronization – Keep data synchronized on multiple systems.
  • Data Transformation – data transformation(Ensemble) Modify data being sent within an Ensemble production.
  • Data Type Classes – data typedata typesDefine properties to contain literal values.
  • Databases – databaseManage Caché database files programmatically (disable and enable journaling, copy, configure, and so on).
  • Date/Time Values – datedatestimetimesdate valuedate valuestime valuetime valuesWork with date/time values.
  • DDL – DDL fileDDL filesWork with DDL statements and with DDL files.
  • Debugging – debugdebuggerDebug programs.
  • Devices – deviceWork 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 – directorydirectoriesdrivesWork with directories and drives programmatically.
  • DLLs and Executables (Non-InterSystems) – DLLDLLsEXEEXEsexecutableexecutablesInvoke dynamic link libraries and executables provided by other vendors.
  • DOMs – DOMWork 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 – SMTPPOP3Send and receive email programmatically.
  • Encryption – encryptencryptingProtect information against unauthorized viewing.
  • Environment Variables – environment variableAccess the value of an environment variable.
  • Exporting Data – export dataExport data programmatically.
  • Extents – extentWork with extent definitions programmatically.
  • FileMan – Convert FileMan files into Caché classes.
  • Files – fileWork with files programmatically (read, write, copy, rename, and so on).
  • FTP – Use FTP from within Caché.
  • Full-Text Searching – full text searchfull text searchingPerform full-text searching.
  • Globals – globalManage globals programmatically (import, export, get size, set collation, configure mappings, and so on).
  • GUIDs (Globally Unique Identifiers) – GUIDGUIDsWork with GUIDs (Globally Unique Identifiers).
  • HL7 Messages – HL7HL7 message(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 dataImport data programmatically.
  • Include Files – include fileExport include files programmatically.
  • Installation – installinstallersCreate custom installers.
  • Inventory Facility – inventoryCreate a catalog of your code.
  • IP Addresses – IP addressnetwork addressnetwork addressesIPv4IPv6Work 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 – licenselicense serverlicense serversAccess information about Caché license usage programmatically; configure license servers.
  • Lists – listWork with lists.
  • Locks – concurrencyconcurrency controllocklock tableRead lock table information programmatically; remove locks; query and adjust lock table parameters.
  • Macros – macroExport 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) – MQExchange messages between Caché and IBM WebSphere MQ.
  • MultiValue – MVmv.logWrite routines and methods in MultiValue; access data stored in MultiValue format; generate MVBasic client classes; write to the mv.log file.
  • Namespaces – namespaceGet 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 – objectDefine 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 – O/Soperating systemsObtain information about the operating system.
  • Operating System Commands – operating systemO/SInvoke operating system commands from within Caché.
  • Packages – packageWork with packages programmatically (compile, export, delete, and so on); configure mappings.
  • Performance Diagnosis – performanceDiagnose performance.
  • Perl – Access Caché from Perl programs.
  • PMML (Predictive Modelling Markup Language) – Execute PMML models.
  • Processes (Jobs) – processprocessesjobjobsGet information about and manipulate CPU processes (known as jobs in Ensemble).
  • Productions – productionbusiness hostbusiness hosts(Ensemble) Work with productions programmatically (start, check status, enable configuration items, stop, and so on).
  • Projects – projectWork with Studio projects programmatically (export, compile, copy, delete, and so on).
  • Publish and Subscribe – PubSubpublishsubscribe(Ensemble) Route messages to subscribers based on their expressed interests.
  • Push Notifications – pushSend push notification messages to iOS and Google devices.
  • Python – Access Caché from Python programs.
  • Regular Expressions – regular expressionregexregexpPerform pattern matching using regular expressions.
  • Reports – reportCreate reports.
  • REST (Web Services and Clients) – RESTweb serviceweb clientCreate REST web services and web clients.
  • Routines – routineWork with routines programmatically (create, compile, get time stamp, export, and so on); configure mappings.
  • SAML Tokens – SAMLAdd SAML tokens to WS-Security headers.
  • SASL – Implement SASL to include authentication in connection-based protocols.
  • Security Items – resourceroleuserprivilegepermissionWork 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) – SOAPweb serviceweb clientCreate SOAP-compliant web services and web clients.
  • Source Control – version controlConnect 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 – Object GatewaySQL GatewayManage and access SQL Gateway connections programmatically (check connections, query by name, and so on).
  • SSH – Use SSH to communicate securely.
  • SSL/TLS – TLS/SSLSSLTLSUse SSL/TLS to communicate securely; obtain information about SSL/TLS connection in use.
  • Startup and Shutdown Behavior – startupshutdownstartstopCustomize startup and shutdown behavior.
  • Status Values – Work with the %Status data type.
  • Streams – streamWork with streams.
  • Studio – Extend Studio and connect Studio to your version control system.
  • Tasks – taskTask ManagerWork with tasks (Task Manager) programmatically (schedule, export definitions, query, and so on).
  • TCP/IP – TCPCommunicate via TCP/IP; work with TCP devices.
  • Telnet – Use Telnet from within Caché.
  • Testing – testPerform 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 – URLParse a URL into its component parts.
  • User Portal – portalProvide a user portal for your end users.
  • Version – Obtain information about the system version.
  • Web Pages – web pagefront enduser interfaceCreate 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 – X.509Use 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) – GlobalsImplement XTP (Extreme Transaction Processing) using Caché databases.