InterSystems IRIS Data Platform Class Reference

https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls
Admin
This is a class reference documentation for the InterSystems IRIS Data Platform, providing an...
Tokens:2,468,842
Snippets:37,930
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Setup and Cleanup Environment Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25UnitTest.TestCase&LIBRARY=ENSLIB

Demonstrates using OnBeforeAllTests and OnAfterAllTests to manage test environment state.

```ObjectScript
Method OnBeforeAllTests() As %Status
{
	//do setup stuff here
 	set ^inputMessage = "input message"
	quit $$$OK
}
Method OnAfterAllTests() As %Status
{
	//do clean up stuff here
	kill ^inputMessage
	quit $$$OK
}
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.MQTT.Tracer&LIBRARY=ENSLIB

Starts the tracing process for the MQTT client.

```APIDOC
## Start()

### Description
Starts the tracing of calls made within the paho-c library.

### Returns
- **%Status** - Returns a status code indicating success or failure.
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Ens.Production&LIBRARY=ENSLIB

Starts the production.

```APIDOC
## Start() as %Status

### Description
Starts the production.
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Monitor.System.LineByLine&LIBRARY=ENSLIB

Starts a line-by-line monitor collection.

```APIDOC
## Start(Routine As %List = "", Metric As %List = "", Process As %List = "") as %Status

### Description
Starts a line-by-line monitor collection using the provided lists of routines, metrics, and process IDs.

### Parameters
- **Routine** (%List) - Optional - List of routines to monitor.
- **Metric** (%List) - Optional - List of metric names.
- **Process** (%List) - Optional - List of process IDs to monitor.
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Monitor.System.LineByLine&LIBRARY=%25SYS

Starts the line-by-line monitor collection.

```APIDOC
## Start(Routine As %List = "", Metric As %List = "", Process As %List = "") as %Status

### Description
Start a line-by-line monitor collection using the provided lists of routines, metrics, and process IDs.

### Parameters
- **Routine** (%List) - Optional - List of routines to monitor.
- **Metric** (%List) - Optional - List of metrics to monitor.
- **Process** (%List) - Optional - List of process IDs to monitor.
```

--------------------------------

### Schedule String Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Ens.Config.Item&LIBRARY=ENSLIB

Example of a schedule string to start a configuration item at 8 a.m. and stop it at 5 p.m. daily.

```text
START:*-*-*T08:00:00,STOP:*-*-*T17:00:00
```

--------------------------------

### Create a Linked Table from MySQL

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.SQL.Schema&LIBRARY=ENSLIB

Example demonstrating the setup of a MySQL table and the corresponding InterSystems IRIS command to link it as a local class.

```sql
create database test1; 
use test1; 
create table Person(PID int,name varchar(255)); 
insert into Person(PID,name) values(1,"Cache")
```

```objectscript
$SYSTEM.SQL.Schema.CreateLinkedTable(dsn,"","Person","PID,name","User.LinkedClass","LinkedTable","")
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.Monitor.AbstractSensor&LIBRARY=%25SYS

An optional method that can be implemented by the user to perform initialization when the System Monitor Controller starts.

```APIDOC
## Start()

### Description
Called once by the System Monitor Controller when it starts. Use this to initialize properties or counters.

### Returns
- **%Status** - Returns $$$OK on success, or 0 on failure.
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.DataCheck.Destination&LIBRARY=%25SYS

Starts the DataCheck system process.

```APIDOC
## Start()

### Description
Starts the DataCheck system process on the destination system.

### Usage
Call this method on an instance of SYS.DataCheck.Destination to initiate the data check.
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.Journal.System&LIBRARY=ENSLIB

Starts the journaling system with specified configuration parameters.

```APIDOC
## Start()

### Description
Starts the journaling system. 

### Parameters
- **curdir** (String) - Primary journal directory
- **altdir** (String) - Alternate journal directory
- **maxsiz** (Integer) - Max size of journal file in bytes
- **expsiz** (Integer) - [Windows & VMS only] unit increment of journal file size in bytes
- **prefix** (String) - A string preceding the standard journal file name
- **okshdw** (Boolean) - OK to share directory with shadow journal files (Default: 0)
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Monitor.OTel&LIBRARY=%25SYS

Starts the OpenTelemetry exporter for metrics and logs.

```APIDOC
## classmethod Start() as %Status

### Description
Start OTel exporter for Metrics and Logs. Normally called by startup if OTel is configured. May also be called manually if the exporter job has exited due to error.
```

--------------------------------

### Example()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25XML.XPATH.Reader&LIBRARY=%25SYS

Provides an example of how to use the %XML.XPATH.Reader class.

```APIDOC
## Example

### Description
Displays an example usage of the %XML.XPATH.Reader class.
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25ZEN.Report.RenderServer&LIBRARY=%25SYS

Starts a Zen Report Hot Server by name.

```APIDOC
## Start(pName As %String, Output pPreviousState As %Integer, Output pReturn As %String, pVerbose As %Boolean = 0) as %Status

### Description
Startup a Zen Report Hot Server given its name.
```

--------------------------------

### Start(args...)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.BackgroundTask&LIBRARY=ENSLIB

Starts a background task and returns a handle for monitoring.

```APIDOC
## Method: Start(args...)

### Description
Starts this task in the background and returns an oref for monitoring and control. Returns null on error, with error status available in %objlasterror.

### Parameters
- **args** (variadic) - Task-specific arguments required by the subclass.

### Returns
- **%ObjectHandle** - An object reference for monitoring the task.
```

--------------------------------

### Install(Name As %String)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Config.NLS.Locale&LIBRARY=%25SYS

Installs a locale by name.

```APIDOC
## Install(Name As %String)

### Description
Installs a locale.

### Parameters
- **Name** (%String) - Required - The name of the locale to install.
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.DataCheck.Destination&LIBRARY=%25SYS

Starts the DataCheck destination system.

```APIDOC
## Start(restartworkflow As %Boolean) As %Status

### Description
Starts the system if not already started. If the 'restartworkflow' parameter is set to true, the workflow will be set to restart at phase #1 rather than resume where it left off. Any changes to the destination object or related objects must be saved before calling this method.
```

--------------------------------

### StartThisGateway()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=EnsLib.Gateway.Service&LIBRARY=ENSLIB

Starts the Gateway Server.

```APIDOC
## StartThisGateway()

### Description
Starts up the Gateway Server.
```

--------------------------------

### Install

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Config.NLS.Locales&LIBRARY=%25SYS

Sets the new current locale and loads its tables.

```APIDOC
## classmethod Install(Locale As %String) as %Status

### Description
Sets the new "current locale" and loads its tables. If the desired locale is not loadable, compiles it before the installation.

### Parameters
- **Locale** (%String) - Locale name.
```

--------------------------------

### StartMirror

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Mirror&LIBRARY=%25SYS

Activates and starts up a mirror.

```APIDOC
## StartMirror(MirrorName As %String = "")

### Description
Activates and starts up a mirror. When MirrorName is null, it performs an initial startup; otherwise, it performs a restart.

### Parameters
- **MirrorName** (String) - Optional - The name of the mirror to start.

### Returns
- **%Status** - Returns $$$OK on success, or $$$ERROR(reason) on failure.
```

--------------------------------

### Start(ByRef response As %String) As %Boolean

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.SASL.XOAUTH2&LIBRARY=%25SYS

Starts the authentication process using the UserName and AccessToken properties.

```APIDOC
## Start(ByRef response As %String) As %Boolean

### Description
Starts authentication based on UserName and AccessToken using the XOAUTH2 SASL mechanism.

### Parameters
- **response** (ByRef %String) - The initial authentication response string generated by the mechanism.
```

--------------------------------

### Start(Directory, TargetFree)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Database.BackgroundFileCompact&LIBRARY=%25SYS

Initiates a background database compaction task for the specified directory.

```APIDOC
## Method: Start

### Description
Starts the Database Compaction utility in the background. Returns an object reference (oref) that can be used to monitor the status and progress of the task.

### Signature
`##class(SYS.Database.BackgroundFileCompact).Start(Directory, TargetFree)`

### Parameters
- **Directory** (String) - The directory path of the database to compact.
- **TargetFree** (Numeric) - The target free space goal for the compaction process.

### Returns
- **oref** (Object) - An instance of SYS.Database.BackgroundFileCompact used to track the background task.
```

--------------------------------

### Start(args...)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.BackgroundTask&LIBRARY=%25SYS

Starts the task in the background and returns an object handle for monitoring.

```APIDOC
## Method: Start(args...)

### Description
Starts this task in the background and returns an oref for monitoring and control. Returns null on error, with error status available in %objlasterror.

### Parameters
- **args...** (variadic) - Arguments specific to each subclass.

### Returns
- **%ObjectHandle** - An object handle for monitoring the task.
```

--------------------------------

### Start Statistics Collection

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.PTools.Stats&LIBRARY=ENSLIB

Example of starting and stopping statistics collection for a specific routine and module.

```ObjectScript
do ##class(%SYS.PTools.Stats).Start($NAMESPACE,"Test","Populate")
do ##class(Sample.Person).Populate(100)
do ##class(%SYS.PTools.Stats).Stop($NAMESPACE,"Test","Populate")
```

--------------------------------

### Start()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.LogDmn&LIBRARY=%25SYS

Starts the log daemon. The daemon must be enabled before calling this method.

```APIDOC
## classmethod Start(ByRef pid As %Integer, timeout As %Double = 5) as %Status

### Description
Starts the log daemon. The timeout parameter specifies the number of seconds to wait for the daemon to start before declaring it unresponsive.
```

--------------------------------

### Help()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.Container&LIBRARY=ENSLIB

Displays a list of all available entrypoints for the %SYSTEM.Container class.

```APIDOC
## Help()

### Description
Displays a list of all entrypoints available for the %SYSTEM.Container class.

### Usage
Do $SYSTEM.Container.Help()
```

--------------------------------

### WS-Management Transfer:Get SOAP Response

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.WSMon.wsman.Service&LIBRARY=%25SYS

Example of a SOAP response message corresponding to the Transfer:Get request.

```xml
<s:Envelope
  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:wsman="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">
  <s:Header>
    <wsa:To>
      http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
    </wsa:To>
    <wsa:Action s:mustUnderstand="true">
      http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse
    </wsa:Action>
    <wsa:MessageID s:mustUnderstand="true">
      urn:uuid:217a431c-b071-3301-9bb8-5f538bec89b8
    </wsa:MessageID>
    <wsa:RelatesTo>
      urn:uuid:d9726315-bc91-430b-9ed8-ce5ffb858a87
    </wsa:RelatesTo>
  </s:Header>
  <s:Body>
    <PhysicalDisk 
      xmlns="http://schemas.example.org/2005/02/samples/physDisk">
      <Manufacturer> Acme, Inc. </Manufacturer>
      <Model> 123-SCSI 42 GB Drive </Model>
      <LUN> 2 </LUN>
      <Cylinders> 16384 </Cylinders>
      <Heads> 80 </Heads>
      <Sectors> 63 </Sectors>
      <OctetsPerSector> 512 </OctetsPerSector>
      <BootPartition> 0 </BootPartition>
    </PhysicalDisk>
  </s:Body>
</s:Envelope>
```

--------------------------------

### Retrieve Server Information via GET

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Api.Atelier&LIBRARY=ENSLIB

Example of the response returned by the GetServer() method when accessed via a GET request.

```JSON
{ "status": { "errors": [], "summary": "" }, "console": [], "result": { "content": { "version": "IRIS for UNIX (Apple Mac OS X for x86-64) 2081.1 (Build 513U) Fri Jan 26 2018 18:21:02 EST", "id": "6D1CB774-B314-11E5-888C-38C986213273", "api": 1, "features": [ { "name": "ENSEMBLE", "enabled": true } ], "namespaces": [ "%SYS", "DOCBOOK", "ENSDEMO", "ENSEMBLE", "SAMPLES", "USER" ] } } }
```

--------------------------------

### WS-Management Transfer:Get SOAP Request

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.WSMon.wsman.Service&LIBRARY=%25SYS

Example of a SOAP request message for a Transfer:Get operation as defined by the WS-Management specification.

```xml
<s:Envelope
  xmlns:s="http://www.w3.org/2003/05/soap-envelope"
  xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
  xmlns:wsman="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">
  <s:Header>
    <wsa:To>http://1.2.3.4/wsman/</wsa:To>
    <wsman:ResourceURI>http://example.org/2005/02/physicalDisk
      </wsman:ResourceURI>
    <wsa:ReplyTo>
      <wsa:Address>
        http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
      </wsa:Address>
    </wsa:ReplyTo> 
    <wsa:Action>
      http://schemas.xmlsoap.org/ws/2004/09/transfer/Get
    </wsa:Action>
    <wsa:MessageID>
      urn:uuid:d9726315-bc91-430b-9ed8-ce5ffb858a87
    </wsa:MessageID>
    <wsman:SelectorSet>
      <wsman:Selector Name="LUN"> 2 </wsman:Selector>
    </wsman:SelectorSet>
    <wsman:OperationTimeout> PT30S </wsman:OperationTimeout>
  </s:Header>
  <s:Body/>
</s:Envelope>
```

--------------------------------

### Startup()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Monitor.System.Servers&LIBRARY=%25SYS

Enables the PERFMON utility to begin collecting system metrics.

```APIDOC
## Method Startup()

### Description
Enables PERFMON collection upon startup of the monitor.

### Returns
- **%Status** - Returns the status of the startup operation.
```

--------------------------------

### Start(Directory)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Database.BackgroundDefragment&LIBRARY=%25SYS

Starts the database defragmentation utility in the background for the specified directory.

```APIDOC
## Method
Start(Directory)

### Description
Initiates a background defragmentation task for the database located in the provided directory. Returns an object reference (oref) to the background task instance, which can be used to monitor progress and status.

### Parameters
- **Directory** (String) - Required - The file system path of the database to be defragmented.
```

--------------------------------

### $SYSTEM.Util.Help()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.Util&LIBRARY=%25SYS

Displays a list of all available entrypoints within the %SYSTEM.Util class.

```APIDOC
## Method: Help()

### Description
Displays a list of all available entrypoints for the %SYSTEM.Util class.

### Usage
Do $SYSTEM.Util.Help()
```

--------------------------------

### Explain SQL Query Execution Plans

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.SQL&LIBRARY=%25SYS

Examples demonstrating how to use $SYSTEM.SQL.Explain to retrieve query plans with various configurations, including JSON output, array formats, and literal substitution.

```ObjectScript
   // --- SQL Query plan & all alternative plans with Stats returned in the 'plan' param. Suppress screen outputs ---
   set sql="SELECT COUNT(*) FROM Sample.Person"
   set tSC=$SYSTEM.SQL.Explain(sql, {"alt":1, "silent":1, "stats":1},,.plan)
   zwrite tSC
   write plan
   
   // --- SQL Query plan with verbose modules output to the current device ---
   set sql="SELECT COUNT(*) FROM Sample.Person"
   set tSC=$SYSTEM.SQL.Explain(sql,{"verbose":1,"stats":1}) 
   zwrite tSC 
   
   // --- SQL Query plan output to the current device; SQL passed by reference; apply literal substitution ---
   kill sql set sql($i(sql))="SELECT COUNT(*) FROM Sample.Person WHERE Name=?" 
   kill dynArgs set dynArgs($i(dynArgs))="John" 
   set tSC=$SYSTEM.SQL.Explain(.sql,{"preparse":1,"stats":1},.dynArgs)
   zwrite tSC
   
   // --- SQL Query plan returned in the 'plan' param as a JSON object. Suppress screen outputs ---
   set sql="SELECT COUNT(*) FROM Sample.Person"
   set tSC=$SYSTEM.SQL.Explain(sql, {"format":"JSON", "silent":1},,.plan)
   zwrite tSC
   zwrite plan
   
   // --- SQL Query plan returned in the 'plan' param as an array. Suppress screen outputs ---
   set sql="SELECT COUNT(*) FROM Sample.Person"
   set tSC=$SYSTEM.SQL.Explain(sql, {"format":"PRINT-ARRAY", "silent":1},,.plan)
   zwrite tSC
   zwrite plan
```

--------------------------------

### Get Current Directory

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.PTools.StatsSQL&LIBRARY=%25SYS

Example showing how to retrieve the current directory of the InterSystems IRIS instance from the terminal.

```ObjectScript
>write $ZU(12,"")
```

--------------------------------

### Example DataMove Configuration and Warnings

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=DataMove.API&LIBRARY=%25SYS

Configuration example showing namespace and database mappings that result in warnings during a DataMove operation.

```text
[Namespaces]
%SYS=IRISSYS
W=WUSER
X=XUSER
Y=YUSER
Z=ZUSER

[Databases]
IRISSYS=c:\iris\mgr
WUSER=c:\wuser
XUSER=c:\xuser
YUSER=c:\yuser
ZUSER=c:\zuser
OLDDB=c:\olddb
NEWDB=c:\newdb

[Map.W]
Global_Y=OLDDB

[Map.X]
Global_Y=OLDDB

[Map.Y]
Global_Y=OLDDB

[Map.Z]
Global_X:Z=OLDDB

Now create a DataMove in namespace W which moves global Y from OLDDB to NEWDB

This will create the DataMove, and also generate the following warnings:

Warnings=3
Warnings(1)="Namespace conflict: Global range 'Y' mapped by 'Y' in Namespace X will be moved. You may need to update the mappings in Namespace X if you still want to access it from that namespace"
Warnings(2)="Namespace conflict: Global range 'Y' mapped by 'Y' in Namespace X will be moved. You may need to update the mappings in Namespace X if you still want to access it from that namespace"
Warnings(3)="Namespace conflict: Global range 'Y' mapped by 'X:Z' in Namespace Z will be moved. You may need to update the mappings in Namespace Z if you still want to access it from that namespace"
```

--------------------------------

### HighlightSpec Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25iKnow.REST.v1&LIBRARY=%25SYS

Example JSON object for configuring highlighting parameters.

```json
{ "tag": "<b>", "limit":0, "name": "Highlighted"}
```

--------------------------------

### Accessing System Help

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.System&LIBRARY=%25SYS

Use this command to retrieve a list of all available entrypoints for system utilities.

```ObjectScript
Do $system.Util.Help()
```

--------------------------------

### SetAutoStart

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Ens.Director&LIBRARY=ENSLIB

Configures a production to start automatically on system startup.

```APIDOC
## SetAutoStart

### Description
Sets the production to start automatically. Passing an empty string clears the auto-start configuration.

### Parameters
- **pProductionName** (%String) - Required - The name of the production to auto-start.
- **pStartupPriority** (%Integer) - Optional - The relative priority for startup.
```

--------------------------------

### Accessing %SYSTEM.Util Help

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.Util&LIBRARY=ENSLIB

Use the Help method to retrieve a list of all available entrypoints within the %SYSTEM.Util class.

```ObjectScript
Do $SYSTEM.Util.Help()
```

--------------------------------

### StartTLSs(LD As %Integer) as %Integer

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.LDAP&LIBRARY=%25SYS

Starts using TLS encryption on an active LDAP session. Requires a certificate to be installed on the client.

```APIDOC
## StartTLSs(LD As %Integer)

### Description
Starts using TLS encryption on an active LDAP session. For Windows, the certificate must be in the Windows certificate database. For Unix, the certificate must be in .PEM format and loaded via SetOption.

### Parameters
- **LD** (%Integer) - Required - The session handle returned by the Init method.

### Return Values
- Returns $$$LDAPSUCCESS on success, or an error code on failure.
```

--------------------------------

### %Init(QName As%String, QMgr As %String, QChannel As %String, ErrorFile As %String = "")

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=%25SYS

Initializes a connection to a queue. This is a required step before sending or receiving messages.

```APIDOC
## %Init

### Description
Creates a connection to a queue. A connection is required before messages can be sent or received.

### Parameters
- **QName** (String) - Required - Host Queue name
- **QMgr** (String) - Optional - Host Queue Manager name. Passing "" connects to the default queue manager.
- **QChannel** (String) - Optional - Host Channel specification, in form <channel>/TCP/<hostname>(<port>)
- **ErrorFile** (String) - Optional - File name to store MQ system returned messages.

### Returns
- **%Boolean** - Returns 0 on failure, 1 on success.
```

--------------------------------

### Get Global Node Counts and Sizing

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Library.GlobalEdit&LIBRARY=%25SYS

Examples demonstrating how to use GetGlobalCountBySubscript to retrieve node counts and journal sizing information for various global ranges.

```ObjectScript
s Status=##Class(%GlobalEdit).GetGlobalCountBySubscript("c:\iris\mgr\user\","DATA","",.Size)
```

```ObjectScript
s x=##Class(%GlobalEdit).GetGlobalCountBySubscript("c:\iris\mgr\user\","DATA(""Jones"")","",.Size)
```

```ObjectScript
s x=##Class(%GlobalEdit).GetGlobalCountBySubscript("c:\iris\mgr\user\","DATA(""Jones"")","DATA(""Smith"",""zzzzz"")",.Size)
```

```ObjectScript
s x=##Class(%GlobalEdit).GetGlobalCountBySubscript("c:\db1\","^X(500"_$c(1)_"*next)","^X(END)",.Size)
```

```ObjectScript
s x=##Class(%GlobalEdit).GetGlobalCountBySubscript("c:\db1\","^X(BEGIN)","^X(500)",.Size)
```

--------------------------------

### Sample()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Stats.Global&LIBRARY=%25SYS

Instantiates the class and populates it with current values for all properties.

```APIDOC
## Method Sample()

### Description
Instantiate the class and fill in current values for all properties.

### Signature
classmethod Sample() as SYS.Stats.Global
```

--------------------------------

### Accessing SQL Help

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.SQL&LIBRARY=ENSLIB

Lists all available entry points for the %SYSTEM.SQL class.

```ObjectScript
Do $SYSTEM.SQL.Help()
```

--------------------------------

### StartAssign(proxy As %ZEN.proxyObject)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25CSP.UI.Portal.Sharding.Dialog.Assign&LIBRARY=%25SYS

Starts a background job to cleanup a selected directory.

```APIDOC
## ClassMethod StartAssign

### Description
Starts a background job to cleanup a selected directory.

### Signature
`StartAssign(proxy As %ZEN.proxyObject) as %ZEN.proxyObject`

### Parameters
- **proxy** (%ZEN.proxyObject) - The proxy object containing assignment details.
```

--------------------------------

### %Init()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=ENSLIB

Initializes the MQ object by setting up the error log file and connecting to the MQ Server.

```APIDOC
## %Init()

### Description
Performs both error log file assignment and connection to the MQ Server in a single method call.

### Returns
- 1 (Integer) - Success
- 0 (Integer) - Failure
```

--------------------------------

### %OnNew

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.MQTT.Client&LIBRARY=ENSLIB

Initializes a new MQTT client instance with connection details and configuration.

```APIDOC
## %OnNew(url, clientid, qos, keepaliveinterval, lwttopic, lwtmessage)

### Description
Creates a new MQTT client instance. Requires a URL (e.g., "tcp://localhost:1883" or "ssl://localhost:8883") and a unique client ID.

### Parameters
- **url** (String) - Required - The broker URL.
- **clientid** (String) - Optional - Unique identifier for the client.
- **qos** (Integer) - Optional - Quality of Service level.
- **keepaliveinterval** (Integer) - Optional - Keepalive interval in seconds.
- **lwttopic** (String) - Optional - Last Will and Testament topic.
- **lwtmessage** (String) - Optional - Last Will and Testament message.
```

--------------------------------

### Sample()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Stats.Disk&LIBRARY=%25SYS

Instantiates the SYS.Stats.Disk class and populates its properties with current disk statistics.

```APIDOC
## classmethod Sample()

### Description
Instantiate the class and fill in current values for all properties.

### Returns
- **SYS.Stats.Disk** - An instance of the class populated with current disk statistics.
```

--------------------------------

### Check OID existence in GUID registry

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25ExtentMgr.GUID&LIBRARY=ENSLIB

Use the idxOIDExists method to verify if an OID is defined in the GUID registry and retrieve its corresponding GUID.

```ObjectScript
	SAMPLES>set person = ##class(Sample.Person).%OpenId(5)
	
	SAMPLES>write "Exists: ",##class(%ExtentMgr.GUID).idxOIDExists(person.%Oid(),.id),", GUID: ",id
	Exists: 1, GUID: A7413A9A-F73C-11DF-BF93-23DF9B6F8200
	SAMPLES>
```

--------------------------------

### $SYSTEM.SQL.Help()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.SQL&LIBRARY=ENSLIB

Provides a list of all available entry points within the %SYSTEM.SQL class.

```APIDOC
## $SYSTEM.SQL.Help()

### Description
Displays a list of all available methods and entry points in the %SYSTEM.SQL class.

### Usage
Do $SYSTEM.SQL.Help()
```

--------------------------------

### Display Available Methods

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.SQL.PTools&LIBRARY=ENSLIB

Use the Help method to list all available entry points for the class.

```ObjectScript
do $SYSTEM.SQL.PTools.Help()
```

--------------------------------

### Install(kitPath As %String, dev As %Integer = 0, update As %Boolean = 0) as %Status

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=SYS.Monitor.DashboardInstaller&LIBRARY=%25SYS

Installs the Dashboard kit in an InterSystems IRIS instance.

```APIDOC
## Install(kitPath As %String, dev As %Integer = 0, update As %Boolean = 0) as %Status

### Description
This method is invoked to install the Dashboard kit in an InterSystems IRIS instance.

### Parameters
- **kitPath** (String) - The directory of the unzipped Dashboard kit.
- **dev** (Integer) - Indicates whether the CSP app should cache files (default 0).
- **update** (Boolean) - Forces the update of the back end with DashboardSupport.xml even if DashboardSensors exists (default 0).

### Returns
- **%Status** - Returns the status of the installation process.
```

--------------------------------

### InstallOnFirstRestart()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Installer.Installer&LIBRARY=ENSLIB

Executes the installation process from the command line upon the first system restart.

```APIDOC
## Method: InstallOnFirstRestart

### Description
Run %Installer.InstallFromCommandLine on the first restart after installation or upgrade.
```

--------------------------------

### AM Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the AM suffix property.

```ObjectScript
"AM"
```

--------------------------------

### Get

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Library.Device&LIBRARY=ENSLIB

Get and open an INPUT or OUTPUT device.

```APIDOC
## Get(Prompt, Value, Help, Flag, Timeout, IOFlag, IOSL, IOM, IOF, IOBS, IOPAR, IOT, IOST, ANS, RMSDF, IODOC, IODES)

### Description
Get and open an INPUT or OUTPUT device based on the provided prompt and flags.

### Parameters
- **Prompt** (%String) - Prompt to be displayed
- **Value** (%String) - Default value
- **Help** (%String) - Array of help text
- **Flag** (%Integer) - From %syPrompt.inc
- **Timeout** (%Integer) - Timeout for prompt
- **IOFlag** (%Integer) - Mask containing device selection options (1=Input/Output, 2=Input, 4=Output, 8=Open without prompt)

### Output Parameters
- **Status** - Success/Error response status
- **Value** - Open device name
- **IOSL** - Number of lines per screen
- **IOM** - Right margin
- **IOBS** - Backspace character
- **IOPAR** - IO parameters
- **IOT** - Device type
- **IOST** - Expanded device type
- **ANS** - Device typed in by user
- **RMSDF** - Default RMS parameters
- **IODOC** - Spool file name
- **IODES** - Spool file description
```

--------------------------------

### Accessing System Monitor Help

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.Monitor&LIBRARY=%25SYS

Displays a list of all available entrypoints for the System Monitor.

```ObjectScript
Do $SYSTEM.Monitor.Help()
```

--------------------------------

### Get

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Library.Device&LIBRARY=%25SYS

Get and open an INPUT or OUTPUT device.

```APIDOC
## Get(Prompt As %String, ByRef Value As %String, ByRef Help As %String, Flag As %Integer = 0, Timeout As %Integer = 0, IOFlag As %Integer = 1, ByRef IOSL As %String, ByRef IOM As %Integer, ByRef IOF As %String, ByRef IOBS As %String, ByRef IOPAR As %String, ByRef IOT As %String, ByRef IOST As %String, ByRef ANS As %String, ByRef RMSDF As %String, ByRef IODOC As %String, ByRef IODES As %String)

### Description
Prompts the user to select and open an input or output device. Returns status and various device parameters.

### Parameters
- **Prompt** (String) - Prompt to be displayed
- **Value** (String) - Default value/Open device name
- **Help** (Array) - Array of help text
- **Flag** (Integer) - From %syPrompt.inc (e.g., DisableBackupCharMask, TrapCtrlCMask)
- **Timeout** (Integer) - Timeout for prompt
- **IOFlag** (Integer) - Mask for device selection (1=Input/Output, 2=Input, 4=Output, 8=Open without prompt)
```

--------------------------------

### startServer(serverName As %String)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25External.Server&LIBRARY=%25SYS

Starts the specified external language server.

```APIDOC
## Class Method: startServer

### Description
Start the External Language Server.

### Parameters
- **serverName** (%String) - Required - The name of the server.
```

--------------------------------

### startServer(serverName As %String)

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25External.Server&LIBRARY=ENSLIB

Starts the specified external language server.

```APIDOC
## startServer

### Description
Start the External Language Server.

### Parameters
- **serverName** (%String) - Required - The name of the server.

### Response
- **Returns** (%Boolean) - True if successful.
```

--------------------------------

### %Connect()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=%25SYS

Establishes a connection to the MQ Server.

```APIDOC
## %Connect()

### Description
Establishes a connection to the MQ Server. The instance must be successfully connected before it can be used for message queuing.

### Returns
- **Status** (Integer) - Returns 1 for success, 0 for failure.
```

--------------------------------

### Highlighting Rules Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25iKnow.REST.v1&LIBRARY=%25SYS

An example array of highlighting rules defining style and selection criteria for entities.

```json
[ { "style": "[]", "role": "concept" },
  { "style": "<b>", "entities": [ "airplane", "pilot" ] } ]
```

--------------------------------

### %Connect()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=ENSLIB

Establishes a connection to the MQ Server.

```APIDOC
## %Connect()

### Description
Establishes a connection to the MQ Server. The instance must be successfully connected before it can be used for message queuing.

### Returns
- 1 (Integer) - Success
- 0 (Integer) - Failure
```

--------------------------------

### Start

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.Journal.System&LIBRARY=%25SYS

Starts the journaling system with specified configuration parameters.

```APIDOC
## Start(curdir, altdir, maxsiz, expsiz, prefix, okshdw)

### Description
Starts the journaling system. Parameters allow configuration of directories, file sizes, and naming prefixes.
```

--------------------------------

### %GUID

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Library.Persistent&LIBRARY=ENSLIB

Returns the GUID assigned to a specific object identity.

```APIDOC
## %GUID(oid As %ObjectIdentity, pDeepSearch As %Integer = 0) as %String

### Description
Returns the GUID assigned to the provided object identity. This method is only runnable if the GUIDENABLED parameter is TRUE.

### Parameters
- **oid** (%ObjectIdentity) - Required - The object identity to retrieve the GUID for.
- **pDeepSearch** (%Integer) - Optional - If true and no GUID is found, performs a deep search of the GUID registry.
```

--------------------------------

### NumericGroupSeparator Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the NumericGroupSeparator property.

```ObjectScript
","
```

--------------------------------

### MonthName Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the MonthName property.

```ObjectScript
" January February March April... November December"
```

--------------------------------

### %Init()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=%25SYS

Initializes the MQ connection by setting the error log and establishing a connection to the MQ server.

```APIDOC
## %Init()

### Description
Performs both error log file assignment and connection to the MQ Server in a single call.

### Returns
- **Status** (Integer) - Returns 1 for success, 0 for failure.
```

--------------------------------

### StartGateway

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=EnsLib.DotNetGateway.Service&LIBRARY=ENSLIB

Start up the .NET Gateway Server. This method is deprecated.

```APIDOC
## StartGateway(pFilePath As %String, pPort As %String, pAllowedIPAddresses As %String, pLogfile As %String = "", ByRef pDevice As %String = "", pServer As %String = "127.0.0.1", pExec64 As %Boolean = 0, pVersion As %String = "2.0", pUsePassphrase As %Boolean = 0) as %Status

### Description
Starts the .NET Gateway Server process.

### Parameters
- **pFilePath** (%String) - Path to the gateway executable.
- **pPort** (%String) - Port to listen on.
- **pAllowedIPAddresses** (%String) - Allowed IP addresses.
- **pLogfile** (%String) - Path to log file.
- **pDevice** (%String) - Device reference.
- **pServer** (%String) - Server address.
- **pExec64** (%Boolean) - Use 64-bit execution.
- **pVersion** (%String) - Gateway version.
- **pUsePassphrase** (%Boolean) - Use passphrase authentication.
```

--------------------------------

### MonthAbbr Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the MonthAbbr property.

```ObjectScript
" Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
```

--------------------------------

### %Init()

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.abstractMQ&LIBRARY=ENSLIB

Initializes a connection to a queue.

```APIDOC
## %Init(QName As %String, QMgr As %String, QChannel As %String, ErrorFile As %String = "")

### Description
Creates a connection to a queue. A connection is required before messages can be sent or received.

### Parameters
- **QName** (String) - Required - Host Queue name.
- **QMgr** (String) - Optional - Host Queue Manager name. Passing "" connects to the default queue manager.
- **QChannel** (String) - Optional - Host Channel specification, in form <channel>/TCP/<hostname>(<port>).
- **ErrorFile** (String) - Optional - For logging, specify a file name to store MQ system returned messages.

### Returns
- **%Boolean** - Returns 1 on success, 0 on failure.
```

--------------------------------

### StartProduction

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=Ens.Director&LIBRARY=ENSLIB

Starts a specified production or the last used production.

```APIDOC
## StartProduction(pProductionName As %String) as %Status

### Description
Starts the production running. If pProductionName is not provided, it defaults to the last production used.

### Parameters
- **pProductionName** (String) - Optional - The name of the production to start.
```

--------------------------------

### MinusSign Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the MinusSign property.

```ObjectScript
"-"
```

--------------------------------

### Typical %SYSTEM.WorkMgr usage sequence

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYSTEM.WorkMgr&LIBRARY=ENSLIB

Demonstrates the standard workflow of initializing the queue, adding work units, and synchronizing completion.

```ObjectScript
  Set queue=$system.WorkMgr.%New() If queue="" ; Report Error, can check %objlasterror for %Status code
  For i=1:1:100 {
  	Set sc=queue.Queue("##class(MyClass).ClassMethod",i) If $$$ISERR(sc) ; Report Error
  }
  Set sc=queue.Sync() If $$$ISERR(sc) ; Report Error
```

--------------------------------

### Start(ByRef response As %String) As %Boolean

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25Net.SASL.Base&LIBRARY=%25SYS

Initiates the authentication process using the configured UserName and Password.

```APIDOC
## Start(ByRef response As %String) As %Boolean

### Description
Starts the authentication process based on the provided UserName and Password using the specific SASL mechanism.

### Parameters
- **response** (ByRef %String) - The initial response string generated by the mechanism to be sent to the server.

### Returns
- **%Boolean** - Returns true if the start was successful, false otherwise.
```

--------------------------------

### DecimalSeparator Property Example

Source: https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?CLASSNAME=%25SYS.NLS.Format&LIBRARY=ENSLIB

Example value for the DecimalSeparator property.

```ObjectScript
"."
```
Tokens:
Raw