InterSystems IRIS

https://docs.intersystems.com/irislatest/
Admin
InterSystems IRIS is a powerful data platform that enables deployment, configuration, and management...
Tokens:11,899,899
Snippets:105,656
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and start IRIS on Windows

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCMF_deploy

Install and start the instance on Windows using the installer executable with the /instance and INSTALLDIR parameters.

```bash
IRIS-2023.2.0.227.0-win_x64.exe /instance IRIS27 INSTALLDIR=C:\InterSystems\IRIS27

```

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

### Run irisinstall_client script

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIUNIX_client

Start the client installation by running the irisinstall_client script from the top level of the installation files. Replace <install-files-dir> with the location of the installation kit.

```bash
# /<install-files-dir>/irisinstall_client

```

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

### irisinstall_silent command line example

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIUNIX_unattended

Example of the irisinstall_silent command line for unattended installation. Set environment variables to define installation parameters, then run the script with optional package arguments. The variables include instance name, install directory, Unicode, security level, user/group, passwords, client components, and whether to start IRIS.

```bash
sudo ISC_PACKAGE_INSTANCENAME="<instancename>"
 ISC_PACKAGE_INSTALLDIR="<installdir>"
 ISC_PACKAGE_UNICODE="Y"|"N"
 ISC_PACKAGE_INITIAL_SECURITY="Normal"|"Locked Down"
 ISC_PACKAGE_MGRUSER="<instanceowner>"
 ISC_PACKAGE_MGRGROUP="<group>"
 ISC_PACKAGE_USER_PASSWORD="<pwd>"
 ISC_PACKAGE_CSPSYSTEM_PASSWORD="<pwd>"
 ISC_PACKAGE_IRISUSER="<user>"
 ISC_PACKAGE_IRISGROUP="<group>"
 ISC_PACKAGE_CLIENT_COMPONENTS="<component1> <component2> ..."
 ISC_PACKAGE_STARTIRIS="Y"|"N"
 ./irisinstall_silent [<pkg> ...]

```

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

### Example of INSTALLERMANIFESTPARAMS with multiple parameters

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIEWIN_clref

Shows how to specify multiple name/value pairs for the INSTALLERMANIFESTPARAMS property, passed to the setup() method of an installation manifest class. Parameters include bbsiz, globals4kb, globals8kb, globals16kb, globals32kb, globals64kb, routines, gmheap, LibPath, locksiz, MaxServerConn, Path, ZFSize, and ZFString.

```plaintext
INSTALLERMANIFESTPARAMS="bbsiz=512000,globals4kb=20,
globals8kb=30,globals16kb=40,globals32kb=50,
globals64kb=100,routines=40,gmheap=10000,
LibPath=c:\libpath\,locksiz=2179648,MaxServerConn=5,
Path=c:\lib\,ZFSize=2000,ZFString=3000"

```

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

### Sample()

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

The Sample() class method instantiates the SYS.WSMon.wsSystem class and populates all properties with current values.

```APIDOC
## classmethod Sample() as SYS.WSMon.wsSystem

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

### Method
classmethod

### Signature
Sample() as SYS.WSMon.wsSystem

### Returns
- **SYS.WSMon.wsSystem** - An instance of the class with current values for all properties.
```

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

### Start ISCAgent for nonroot instance on UNIX/Linux/macOS

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GHA_mirror_set_config

For a nonroot instance, the installing user starts the ISCAgent by running the ISCAgentUser script (located in the IRISSYS directory) in the background. The example uses nohup and an ampersand.

```bash
nohup <IRISSYS_directory>/ISCAgentUser &

```

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

### Range aggregation using PERIODSTODATE

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=D2GMDX_ch_calculated_members

Example expression that gets the range of days from the start of the current year to today and aggregates them using PERIODSTODATE.

```mdx
%OR(PERIODSTODATE(DateOfSale.YearSold,DateOfSale.DaySold.[NOW]))

```

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

### Initial install script with Import and echo

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIEUNIX_unixdist

Shows the initial version of the install script that imports the host parameter and writes a configuration file. The script uses the placeholder '????' for paths that are later resolved by importing from other packages.

```shell
#!/bin/sh
. parameters.include 
Import host foo9000.host
echo host=$host > ????/mgr/foo9000.cfg
cp ????/dist/foo9000/????/libfoo9000.so ????/bin

```

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

### OnStart(pTimeStarted As %String) as %Status

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

Override this in your Production class to do setup before the Production starts.

```APIDOC
## OnStart(pTimeStarted As %String) as %Status

### Description
Override this in your Production class to do setup before the Production starts.

### Method
classmethod

### Parameters
- **pTimeStarted** (%String) - Required - The time the production started.

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

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

### Set manifest log level in setup() method

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIEMISC_manifest

Sets the log level via the second argument of setup() and directs where messages are displayed via the fourth argument (%Installer.AbstractLogger). For example, instantiate a %Installer.FileLogger object referencing an OS file to direct all %Installer and log messages there. Without the fourth argument, messages go to the primary device if setup() is called directly, and are ignored if executed by the installer.

```objectscript
ClassMethod setup(ByRef pVars, pLogLevel As %Integer = 3, 
   pInstaller As %Installer.Installer, 
   pLogger As %Installer.AbstractLogger) 
   As %Status [ CodeMode = objectgenerator, Internal ]

```

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

### order(key) example: get next key from given key

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GEPYTHON_reference_gref

Shows how to use order() to get the next key at a given level. The starting key does not need to exist; order() returns the next key in sorted order.

```python
>>> m = iris.gref('^mlb')
>>> m.order(['AL','Central'])
'East'
>>> m.order(['AL','East'])
'West'
>>> m.order(['AL','East',1])
'2'
>>> m.order(['AL','East',2])
'3'

```

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

### Traverse a global with square.order

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GEPYTHON_sharedata

Shows how `order()` returns the next key in the global, similar to `$ORDER`. The example starts with key 5 and gets the next key, which is 12.

```python
>>> key = 5
>>> key = square.order([key])
>>> print(key)
12
```

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

### OnStart(pConfigName)

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

This user callback method is called when the system is being started.

```APIDOC
## OnStart(pConfigName)

### Description
This user callback method is called when the system is being started.

### Method
classmethod

### Signature
classmethod OnStart(pConfigName As %String) As %Status

### Parameters
- **pConfigName** (%String) - Required - The configuration name.

### Returns
Returns a %Status indicating success or failure.
```

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

### InstallFromGbl(gbl As %String, qspec As %String, runinstall As %Boolean = 1, ByRef project As %Studio.Project, listonly As %Integer = 0, backupgbl As %String = "", validatesig As %Boolean = 0, transaction As %Boolean = 1)

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

Installs routines, classes, and globals into the current namespace from a global created with DeployToGbl(). Supports qualifiers, project population, listing, backup, and transaction control.

```APIDOC
## InstallFromGbl(gbl As %String, qspec As %String, runinstall As %Boolean = 1, ByRef project As %Studio.Project, listonly As %Integer = 0, backupgbl As %String = "", validatesig As %Boolean = 0, transaction As %Boolean = 1)

### Description
Installs any routines, classes, and globals into the current namespace from a global created with the DeployToGbl(). The qualifiers respects the /importselectivity item to determine if we should import selectivity information from this package. If you pass in a %Studio.Project in project then this will be returned with all the items in the deployment in gbl added to the project. If listonly is true then nothing will be actually changed in the database, so you can list items. If runinstall is true then if the deployment contains a routine called 'INSTALL' (note not in the database, but in the deployment) then we will automatically run PRE^INSTALL before the installation and ^INSTALL after installing the items in this deployment. The default is to run the INSTALL routine if present. If backupgbl is defined then any items which will be replaced by items in the package are backed up to this global location first. Also if the deployment contains an INSTALL routine then this will be placed in the backup as UNINSTALL, and if the deployment contains an UNINSTALL routine this will be placed in the backup as INSTALL. So when the backup is installed (do you uninstall this deployment) it will run the PRE^UNINSTALL routine of the original deployment and after it is uninstalled it will run ^UNINSTALL. If transaction is false then we will not use a transaction to allow rolling back the install. If validatesig is true we will validate any code being replaced is the original version installed from InterSystems.

### Method
classmethod

### Parameters
- **gbl** (As %String) - Required - The global containing the deployment.
- **qspec** (As %String) - Required - Qualifiers for the installation.
- **runinstall** (As %Boolean) - Optional - Default 1 - If true, runs the INSTALL routine if present.
- **project** (ByRef As %Studio.Project) - Optional - If passed, will be returned with all items in the deployment added.
- **listonly** (As %Integer) - Optional - Default 0 - If true, only lists items without changing the database.
- **backupgbl** (As %String) - Optional - Default "" - If defined, replaced items are backed up to this global.
- **validatesig** (As %Boolean) - Optional - Default 0 - If true, validates that replaced code is the original InterSystems version.
- **transaction** (As %Boolean) - Optional - Default 1 - If false, does not use a transaction for rollback.

### Returns
No explicit return value documented.
```

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

### Blank installation manifest template

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIEMISC_manifest

A minimal installation manifest template with placeholder elements for Namespace, Import, Invoke, CopyFile, and CopyDir. Use it as a starting point for creating your own manifest. The setup method is a method generator that uses XGL to generate code from the XData block.

```objectscript
Include %occInclude

/// Simple example of installation instructions (Manifest)
Class MyInstallerPackage.SimpleManifest
{

XData SimpleManifest [ XMLNamespace = INSTALLER ]
{
<Manifest>
   <Log Level="3" Text="Start manifest" />
   <Namespace Name="">
      <Import File="" />
      <Invoke Class="" Method="" CheckStatus="" Return=""> 
         <Arg Value=""/>
      </Invoke> 
   </Namespace>
   <CopyFile Src="" Target="" IgnoreErrors=""/>
   <CopyDir Src="" Target="" IgnoreErrors=""/>   
   <Log Level="3" Text="End manifest" />
</Manifest>
}

/// This is a method generator whose code is generated by XGL.
ClassMethod setup(ByRef pVars, pLogLevel As %Integer = 3, 
   pInstaller As %Installer.Installer, 
   pLogger As %Installer.AbstractLogger) 
   As %Status [ CodeMode = objectgenerator, Internal ]
{
    #; Let our XGL document generate code for this method. 
    Quit ##class(%Installer.Manifest).%Generate(%compiledclass, %code, "SimpleManifest")
}

}
```

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

### InstallFromFile(file, qspec, runinstall, project, listonly, backupgbl, validatesig, transaction)

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

Installs routines, classes, and globals from a deployment file created with DeployToFile(). Supports selective installation and validation.

```APIDOC
## InstallFromFile(file, qspec, runinstall, project, listonly, backupgbl, validatesig, transaction)

### Description
Installs routines, classes, and globals from a deployment file created with DeployToFile(). Supports selective installation and validation.

### Method
classmethod

### Parameters
- **file** (%String) - Required - The deployment file to install from.
- **qspec** (%String) - Required - Qualifier string; respects /importselectivity to determine if selectivity information should be imported.
- **runinstall** (%Boolean) - Optional - If false, does not automatically run the INSTALL routine if present. Defaults to 1.
- **project** (%Studio.Project, ByRef) - Optional - If provided, returns a %Studio.Project object with all items in the deployment added.
- **listonly** (%Boolean) - Optional - If true, does not change the database, only lists items. Defaults to 0.
- **backupgbl** (%String) - Optional - Backup global name. Defaults to "".
- **validatesig** (%Boolean) - Optional - If true, validates signatures. Defaults to 0.
- **transaction** (%Boolean) - Optional - If true, uses a transaction. Defaults to 1.

### Response
No return value is documented.
```

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

### Override Initialize() method

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCM_healthmon_appmon

Example of overriding the Initialize() method, which is called at the start of each metrics gathering run. It prepares a class query to get free space information and stores the result set.

```objectscript
/// Initialize the list of datasets and freespace.
Method Initialize() As %Status
{
    set stmt=##class(%SQL.Statement).%New()
    set status= stmt.%PrepareClassQuery("SYS.Database","FreeSpace")
    set ..Rspec = stmt.%Execute()
    return $$$OK
}
```

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

### Run sudo irisinstall

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIUNIX_install

Start the installation by running the irisinstall script located at the top level of the installation files. Replace <install-files-dir> with the location of the installation kit. If sudo is unavailable, a non-standard limited installation as a nonroot user is possible, but has significant limitations.

```bash
# sudo /<install-files-dir>/irisinstall

```

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

### Get and Set IsolationMode with START TRANSACTION

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=RSQL_settransaction

Shows how to query the current isolation mode with GetOption("IsolationMode"), start a transaction with READ COMMITTED, and change the isolation mode to 0 (READ UNCOMMITTED) using SetOption. The example prints the isolation mode before and after each operation and handles the SetOption status.

```ObjectScript
   WRITE $SYSTEM.SQL.Util.GetOption("IsolationMode")," default",!
   &sql(START TRANSACTION ISOLATION LEVEL READ COMMITTED,READ WRITE)
   WRITE $SYSTEM.SQL.Util.GetOption("IsolationMode")," after START TRANSACTION",!
   DO $SYSTEM.SQL.Util.SetOption("IsolationMode",0,.stat)
   IF stat=1 {
     WRITE $SYSTEM.SQL.Util.GetOption("IsolationMode")," after IsolationMode=0 call",! }
   ELSE { WRITE "Set IsolationMode error" }
   &sql(COMMIT)

```

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

### Install with default instance name and custom directory

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIWIN_unattended

Installs an instance with the default instance name into the specified directory. The /qn flag makes the installation fully silent.

```text
C:\downloads\IRIS-<version_number>-win_x64.exe /qn INSTALLDIR=C:\InterSystems\MyIris

```

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

### Import example with %Import

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=D2IMP_expimp_other

Example of importing a folder item with pReplace=1 and pVerbose=1.

```objectscript
 set filename="c:/test/Chart-Demos-Area-Chart-pivot.xml"
 do ##class(%DeepSee.UserLibrary.Utils).%Import(filename,1,1) 
```

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

### Install IRIS without starting (UNIX/Linux)

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GCMF_deploy

Precede the irisinstall script with ISC_PACKAGE_STARTIRIS="N" to install the instance without starting it. This is required to apply a merge file during installation.

```bash
ISC_PACKAGE_INSTANCENAME="IRIS27" ISC_PACKAGE_STARTIRIS="N" /tmp/iriskit/irisinstall

```

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

### Launch installation with command line properties

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIWIN_wizard

Use this command to launch the installer from the command line, allowing you to set properties like ISCSTARTIRIS=0 and ISCSTARTLAUNCHER=0 to prevent the instance from starting immediately after installation.

```batch
C:\Users\Public\Downloads\IRIS-<version_number>-win_x64.exe ISCSTARTIRIS=0 ISCSTARTLAUNCHER=0 
```

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

### DoesNotStartWith function example

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=EBUS_utility_functions

Returns 1 if the value does not start with the substring. Example tests for absence of 'ABC' at the start of a source property.

```objectscript
DoesNotStartWith(source.SampleProperty,"ABC")
```

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

### OnProductionStart(pConfigName)

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

This user callback method is called when the system is being started.

```APIDOC
## OnProductionStart(pConfigName)

### Description
This user callback method is called when the system is being started.

### Method
classmethod

### Signature
classmethod OnProductionStart(pConfigName As %String) As %Status

### Parameters
- **pConfigName** (%String) - Required - The configuration name.

### Returns
Returns a %Status indicating success or failure.
```

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

### Request JSON array for GetModifiedDocNames

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSCF_ref

Example of the JSON array to post to the API. It contains database name and hash pairs. Typically, start with an empty array to get all files, then use the returned dbname and dbhash to check for modifications.

```json
[ { "dbname" : "USER",
    "dbhash" : "KWAGbOdnRblPzANaiv1Oiu0BZLI" 
}, ... ]

```

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

### Get SqlSysDatatypes configuration example

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

Shows how to retrieve the configuration for a datatype named BIGINT using the Get method. The example sets the Name variable, calls Get, checks the status, and displays the properties with zwrite.

```objectscript
%SYS>s Name="BIGINT"
%SYS>s Status=##Class(Config.SqlSysDatatypes).Get(Name,.Properties)
%SYS>i '$Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("Datatype")="%Library.BigInt"
```

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

### Start() as %Integer

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

Starts the System Monitor.

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

### Description
Start the System Monitor.

### Method
classmethod

### Returns
- **%Integer** - The result of the operation.
```

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

### startServer()

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=BEXTSERV_refapi

Starts the server.

```APIDOC
## startServer()

### Description
Starts the server.

### Method
ObjectScript method call

### Endpoint
$system.external.startServer()

### Parameters
None

### Request Example
```
do $system.external.startServer()
```

### Response
#### Success Response
No return value.

```

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

### Example: sending a GET request

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?FIND=CLASSES+%25Net.HttpRequest

Creates a new %Net.HttpRequest instance, sets the Server property to "www.intersystems.com", and sends a GET request to the root path. This is a simple example of using the Get() method.

```objectscript
 Set httprequest=##class(%Net.HttpRequest).%New()
 Set httprequest.Server="www.intersystems.com"
 Do httprequest.Get("/")
```

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

### %GUIDGetNextOp(guid, num)

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

Gets the next operation for a given GUID.

```APIDOC
## %GUIDGetNextOp(guid, num)

### Description
Gets the next operation for a given GUID.

### Method
classmethod

### Signature
%GUIDGetNextOp(guid As %String, ByRef num As %String) As %RawString

### Parameters
- **guid** (%String) - Required - The GUID to query.
- **num** (%String) - ByRef - Output parameter for the operation number.

### Returns
- **%RawString** - The next operation information.
```

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

### Install deployment file with InstallFromFile()

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=ADEPLOY

Call this class method on the customer's system in the ObjectScript shell to install the deployment file. Switch to the appropriate namespace first.

```objectscript
set sc=##class(%Studio.Project).InstallFromFile("c:\test\myglobal.xml")

```

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

### clientmethod startBuild() [ Language = javascript ]

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

Start the index build.

```APIDOC
## clientmethod startBuild() [ Language = javascript ]

### Description
Start the index build.

### Method
clientmethod
```

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

### %GUIDGetLastOp(guid, num)

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

Gets the last operation for a given GUID.

```APIDOC
## %GUIDGetLastOp(guid, num)

### Description
Gets the last operation for a given GUID.

### Method
classmethod

### Signature
%GUIDGetLastOp(guid As %String, ByRef num As %String) As %RawString

### Parameters
- **guid** (%String) - Required - The GUID to query.
- **num** (%String) - ByRef - Output parameter for the operation number.

### Returns
- **%RawString** - The last operation information.
```

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

### $PROPERTY example: get property value

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GORIENT_object

Shows how to use $PROPERTY to get the value of a property for an instance. The example opens a Sample.Person object and writes its Name property.

```objectscript
TESTNAMESPACE>set obj=##class(Sample.Person).%OpenId(2)
 
TESTNAMESPACE>write $property(obj,"Name")
Edison,Patrick J.

```

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

### UNIX installation package tutorial: shell commands and parameters script

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GIEUNIX_unixdist

All shell commands and scripts shown in the UNIX installation package tutorial, including listing the existing kit and library, creating the package directory, creating the manifest, writing the parameters script, running it, and the revised script using the Export function.

```shell
~/kit:>ls
irisinstall   cplatname docs  lgpl.txt NOTICE
copyright.pdf dist   kitlist LICENSE package

```

```shell
~/lib:>ls
libfoo9000.so

```

```shell
~/kit:>cd dist
~/kit/dist:>mkdir foo9000
~/kit/dist:>cd foo9000
~/kit/dist/foo9000:>mkdir lnxsusex64
~/kit/dist/foo9000:>cd lnxsusex64
~/kit/dist/foo9000/lnxsusex64:>cp ~/lib/libfoo9000.so .

```

```shell
~/kit/package:>mkdir foo9000
~/kit/package:>cd foo9000
~/kit/package/foo9000:>emacs manifest.isc
package: foo9000

```

```shell
~/kit/package/foo9000:>emacs parameters
#!/bin/sh
echo "Please enter host name of the Foo9000 imaging server: "
read host
echo "Host $host entered."

```

```shell
~/kit/package/foo9000:>sh parameters
Please enter host name of the Foo9000 imaging server:
host1
Host host1 entered.

```

```shell
#!/bin/sh
. parameters.include
echo "Please enter host name of the Foo9000 imaging server: "
read host
echo "Host $host entered."
Export foo9000.host $host

```

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

### Example administrator session command for UNIX instance MyIRIS

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSA_license

Example command for an instance named MyIRIS installed in the default directory. Replace the path with your actual install directory.

```bash
User:/InterSystems/MyIRIS/bin$ iris terminal MyIRIS -B

```

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

### Download the Samples-Data repo using wget and tar

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?FIND=landing+githubsamples

Concrete example of the previous command using the Samples-Data repository and the /samples directory. Run this from the shell to download and extract the sample.

```bash
wget -qO- https://github.com/intersystems/Samples-Data/archive/master.tar.gz | tar xvz -C /samples
```

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

### Output of startServer()

Source: https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=BEXTSERV_managing

The output of the startServer() example, showing that the server was successfully started (1).

```objectscript
   1

```
Tokens:
Raw