docs.intersystems.com
InterSystems IRIS Data Platform 2019.2  /  Configuration Parameter File Reference

Configuration Parameter File Reference
CPF Settings in the Management Portal
Previous section          
InterSystems: The power behind what matters   
Search:  


This appendix contains information about the Management Portal equivalents of parameters in the CPF file. The Configuration section of the Management Portal (System Administration > Configuration), which the structure of this appendix mimics, contains the following submenus:
For information on the other areas in the Management Portal, see the Management Portal Functional Overview section of the “Using the Management Portal” chapter in System Administration Guide.
SQL and Object Settings
The SQL and Object Settings menu (System Administration > Configuration > SQL and Object Settings) contains pages where you can configure InterSystems SQL settings. These pages are:
SQL
InterSystems IRIS includes support for many SQL configuration settings. The SQL page (System Administration > Configuration > SQL and Object Settings > SQL) contains the following tabs:
Many of the same options can also be displayed by invoking $SYSTEM.SQL.CurrentSettings() method.
SQL Tab
The SQL Tab allows you to configure various SQL settings. The following table contains a brief description of each option, and a link to the corresponding parameter in the CPF file.
SQL Tab Setting Description Equivalent CPF file parameter
Retain cached query source Save the source code for cached query routines. SaveMac
Default time precision for GETDATE(), CURRENT_TIME, and CURRENT_TIMESTAMP Set the default time precision for SQL scalar time functions. TimePrecision
Lock escalation threshold Set the SQL lock threshold. LockThreshold
TO_DATE default format Set the default date format for the SQL TO_DATE() function. TODATEDefaultFormat
Default length for VARCHAR Set the MaxLen for ODBC fields of type VarChar. ODBC VarcharMaxlen
Default schema Set the default SQL schema name. DefaultSchema
Execute queries in a single process Allow parallel processing system-wide. AutoParallel
Define primary key as ID key for tables created via DDL Set primary key constraint behavior. IdKey
Ignore redundant DDL statements Suppress certain SQL errors. All the DDLNO* parameters in the [SQL] section.
GROUP BY and DISTINCT queries must produce original values Disallow SQL DISTINCT optimization. FastDistinct
Optimize queries based on parameter values Configure SQL query optimization.
Lock timeout (seconds) Set the SQL lock timeout. [SQL] LockTimeout
TCP keepalive for client connections Set the number of seconds between keep-alive messages. [SQL] TCPKeepAlive
SQL Shell Tab
The SQL Shell Tab allows you to configure the SQL shell. You can use the SQL shell to execute SQL statements dynamically. For more information, see the Configuring the SQL Shell section of the “Using the SQL Shell Interface” chapter in Using InterSystems SQL.
Objects
The General Object Settings page (System Administration > Configuration > SQL and Object Settings > Objects) contains a swizzling option. For more information, see Swizzling a Fieldname Property with %ObjectSelectMode=1 in the “Using Dynamic SQL” chapter in Using InterSystems SQL.
TSQL Compatibility
From the TSQL Settings page (System Administration > Configuration > SQL and Object Settings > TISQL Compatibility), you can configure the behavior of the compiler and colorizer. See the TSQL Settings chapter in Transact-SQL (TSQL) Migration Guide for more information.
ISQL Compatibility
From the Informix SQL Settings page (System Administration > Configuration > SQL and Object Settings > ISQL Compatibility), you can configure settings to aid in the migration of ISQL to InterSystems SQL. See the ISQL Configuration Settings section of the “Overview” chapter in ISQL Migration Guide for more information.
System DDL Mappings
The System-Defined DDL Mappings page (System Administration > Configuration > SQL and Object Settings > System DDL Mappings) displays system mappings of SQL datatypes to their InterSystems IRIS equivalents. See the System Datatypes reference for more information about this section. For more information about SQL datatypes, see the Data Types chapter in InterSystems SQL Reference.
User DDL Mappings)
From the User-Defined DDL Mappings page (System Administration > Configuration > SQL and Object Settings > User DDL Mappings), you can map SQL datatypes to their InterSystems IRIS equivalents. See the User Datatypes reference for more information about this section. For more information about SQL datatypes, see the Data Types chapter in InterSystems SQL Reference.
National Language Settings
The National Language Settings menu (System Administration > Configuration > National Language Settings) contains pages where you can configure national language locale definitions. For more information, see the Configuring National Language Support section of the “Configuring InterSystems IRIS” chapter in System Administration Guide.
Device Settings
The Device Settings menu (System Administration > Configuration > Device Settings) contains pages where you can configure devices.
Devices
Define device types. See the Devices reference page.
Device Subtypes
Define device subtypes. See the DeviceSubTypes reference page.
IO Settings
On the IO Settings page (System Administration > Configuration > Device Settings > IO Settings), you can set the mnemonic for WRITE commands to the following locations:
Write location Equivalent CPF file parameter
File File
Other Other
Terminal Terminal
The default mnemonic for each location is ^%X364.
Telnet Settings
InterSystems IRIS Telnet settings apply only to Windows configurations in which InterSystems supplies the Telnet servers. They do not apply to UNIX® or Linux configurations, in which Telnet is supplied by the operating system vendor.
The Telnet Settings page (System Administration > Configuration > Device Settings > Telnet Settings) contains the following settings:
Telnet Setting Description Equivalent CPF file parameter
DNS Lookup Allow DNS lookup of the Telnet client address. DNSLookup
Telnet Port Number Set the Telnet port number. Port
Additional Settings
The Additional Settings menu (System Administration > Configuration > Additional Settings) contains the following pages:
Compatibility Settings
The Compatibility page (System Administration > Configuration > Additional Settings > Compatibility) contains the following settings:
AsyncDisconnectErr
Allow processes to receive disconnect errors asynchronously. This setting corresponds to the AsyncDisconnectErr parameter in the CPF file.
AsynchError
Allow processes to receive asynchronous errors. This setting corresponds to the AsynchError parameter in the CPF file.
BreakMode
Specify programmer mode response to the BREAK command. This setting corresponds to the BreakMode parameter in the CPF file.
CollectResourceStats
Allow InterSystems IRIS to collect system resource statistics. This setting corresponds to the CollectResourceStats parameter in the CPF file.
DisconnectErr
Specify how processes respond to a disconnect. This setting corresponds to the DisconnectErr parameter in the CPF file.
FileMode
Allow writing to a non-existent file. This setting corresponds to the FileMode parameter in the CPF file.
GlobalKillEnabled
Allow KILL of an unsubscripted global. This setting corresponds to the GlobalKillEnabled parameter in the CPF file.
IEEEError
Specify whether $DOUBLE returns INF and NAN values system-wide. This setting corresponds to the IEEEError parameter in the CPF file.
LineRecall
Allow command line recall for READ commands. This setting corresponds to the LineRecall parameter in the CPF file.
LogRollback
Allow logging for transaction rollbacks. This setting corresponds to the LogRollback parameter in the CPF file.
MVDefined
Not in use.
NodeNameInPid
Specify behavior when InterSystems IRIS references the special variable $JOB. This setting corresponds to the NodeNameInPid parameter in the CPF file.
NullSubscripts
 Allow null subscripts on global references. This setting corresponds to the NullSubscripts parameter in the CPF file.
OldZU5
Specify whether to clear global vectors when switching namespace. This setting corresponds to the OldZU5 parameter in the CPF file.
OpenMode
Specify read/write mode to use when opening sequential files. This setting corresponds to the OpenMode parameter in the CPF file.
PopError
Specify when to pop error handlers off the stack. This setting corresponds to the PopError parameter in the CPF file.
RefInKind
Specify how $NAME and $QUERY handle extended global references. This setting corresponds to the RefInKind parameter in the CPF file.
ScientificNotation
Allow lowercase "e" as scientific notation symbol system-wide. This setting corresponds to the ScientificNotation parameter in the CPF file.
SetZEOF
Specify the behavior when reading a sequential file and encountering an unexpected end-of-file error. This setting corresponds to the SetZEOF parameter in the CPF file.
ShutDownLogErrors
Allow writing of InterSystems IRIS system error log entries to the messages.log file on shutdown. This setting corresponds to the ShutDownLogErrors parameter in the CPF file.
StopID
Not in use.
SwitchOSdir
Disallow switching current working directories when changing namespaces. This setting corresponds to the SwitchOSdir parameter in the CPF file.
SynchCommit
Disable synchronizing TCOMMIT with the corresponding journal write operation. This setting corresponds to the SynchCommit parameter in the CPF file.
TelnetNUL
Suppress Telnet NUL at end-of-line for Telnet transmission. Windows systems only. This setting corresponds to the TelnetNUL parameter in the CPF file.
TruncateOverflow
Suppress the <MAXNUMBER> error on numeric overflow. This setting corresponds to the TruncateOverflow parameter in the CPF file.
Undefined
Specify the response when ObjectScript attempts to fetch a variable that does not exist. This setting corresponds to the Undefined parameter in the CPF file.
UseNagleAlgorithm
Allow InterSystems IRIS to use the Nagle algorithm for Telnet. This setting corresponds to the UseNagleAlgorithm parameter in the CPF file.
ViewPastData
Allow $VIEW to examine data outside of InterSystems IRIS memory area. This setting corresponds to the ViewPastData parameter in the CPF file.
ZDateNull
Specify the $ZDATE response to an invalid value. This setting corresponds to the ZDateNull parameter in the CPF file.
Advanced Memory
The Advanced Memory page (System Administration > Configuration > Additional Settings > Advanced Memory) contains the following memory-related setting:
Important:
To allocate memory to routine and database caches, visit the Memory and Startup page (System Administration > Configuration > System Configuration > Memory and Startup). When first installed, InterSystems IRIS Data Platform™ sets this cache allocation to happen Automatically. This automatic setting is not appropriate for production use. Before deploying the system for production use or performing any tests or benchmarking intended to simulate production use, you must manually create an appropriate memory allocation by selecting Manually.
For details, see Memory and Startup Settings in the “Configuring InterSystems IRIS” chapter in System Administration Guide.
BackoffDisabled
This setting corresponds to the BackoffDisabled (memlock) flag in the CPF file.
ConsoleFile
Set the path to the console log file (messages.log). This setting corresponds to the console parameter in the CPF file.
LargePagesDisabled
This setting corresponds to the LargePagesDisabled (memlock) flag in the CPF file.
LargePagesRequired
This setting corresponds to the LargePagesRequired (memlock) flag in the CPF file.
LibPath
Set the LD_LIBRARY_PATH environment variable. UNIX® systems only. This setting corresponds to the LibPath parameter in the CPF file.
LineRecallBuffer
This setting corresponds to the LineRecallBuffer (history) option in the CPF file.
LineRecallEntries
This setting corresponds to the LineRecallEntries (hisory) option in the CPF file.
LockSharedMemory
This setting corresponds to the LockSharedMemory (memlock) flag in the CPF file.
LockTextSegment
This setting corresponds to the LockTextSegment (memlock) flag in the CPF file.
MaxServerConn
Set the maximum number of connections from ECP clients. This setting corresponds to the MaxServerConn parameter in the CPF file.
MaxServers
Set the maximum number of connections to ECP servers. This setting corresponds to the MaxServers parameter in the CPF file.
Path
Add directories to the default path environment variable. UNIX® systems only. This setting corresponds to the Path parameter in the CPF file.
VMSConsoleTerminal
Not in use.
ZFSize
This setting corresponds to the ZFSize (zfheap) option in the CPF file.
ZFString
This setting corresponds to the ZFString (zfheap) option in the CPF file.
errlog
Set the maximum number of entries in the error log. This setting corresponds to the errlog parameter in the CPF file.
gmheap
Set the size of the generic memory heap. This setting corresponds to the gmheap parameter in the CPF file.
ijcbuff
Set the size of an InterJob Communication buffer. This setting corresponds to the ijcbuff parameter in the CPF file.
ijcnum
Set the number of InterJob Communication devices. This setting corresponds to the ijcnum parameter in the CPF file.
jrnbufs
Allocate memory for journal buffers. This setting corresponds to the jrnbufs parameter in the CPF file.
locksiz
Set the maximum size of shared memory for locks. This setting corresponds to the locksiz parameter in the CPF file.
netjob
Allow remote job requests. This setting corresponds to the netjob parameter in the CPF file.
nlstab
Set the number of NLS collation tables. This setting corresponds to the nlstab parameter in the CPF file.
targwijsz
Set the desired size of the wij. This setting corresponds to the targwijsz parameter in the CPF file.
udevtabsiz
Set the maximum size of the device table. This setting corresponds to the udevtabsiz parameter in the CPF file.
Monitor Settings
Allow automatic Simple Network Management Protocol (SNMP) startup. For more information about this option, see the SNMPEnabled reference page. For more information about SNMP, see Monitoring InterSystems IRIS Using SNMP in the Monitoring Guide.
Source Control
For information on source control, see Integrating InterSystems IRIS with Source Control Systems.
Startup Settings
The Startup Settings page (System Administration > Configuration > Additional Settings > Startup) contains the following settings:
CallinHalt
Allow custom routines during callin close. This setting corresponds to the CallinHalt parameter in the CPF file.
CallinStart
Allow custom routines during callin initialization. This setting corresponds to the CallinStart parameter in the CPF file.
CliSysName
Set the node name for the local system. This setting corresponds to the CliSysName parameter in the CPF file.
DBSizesAllowed
Specify possible database block sizes when creating a database. This setting corresponds to the DBSizesAllowed parameter in the CPF file.
DefaultPortBindAddress
Set the port number for the InterSystems IRIS superserver. This setting corresponds to the DefaultPortBindAddress parameter in the CPF file.
EnableVSSBackup
Allow Volume Shadow Copy Service (VSS) backup. Windows systems only. This setting corresponds to the EnableVSSBackup parameter in the CPF file.
EnsembleAutoStart
Allow productions to auto-start when InterSystems IRIS starts. This setting corresponds to the EnsembleAutoStart parameter in the CPF file.
ErrorPurge
Set the number of days to keep error globals. This setting corresponds to the ErrorPurge parameter in the CPF file.
FIPSMode
Enable FIPS 140–2 compliant library for database encryption on Red Hat Linux. This setting corresponds to the FIPSMode parameter in the CPF file.
IPv6
Allow InterSystems IRIS to accept IPv6 addresses.This setting corresponds to the IPv6 parameter in the CPF file.
JobHalt
Allow custom routines during background process (job) shutdown. This setting corresponds to the JobHalt parameter in the CPF file.
JobServers
Set the number of job servers. This setting corresponds to the JobServers parameter in the CPF file.
JobStart
Allow custom routines during background process (job) startup. This setting corresponds to the JobStart parameter in the CPF file.
LicenseID
Allow instance to requests a key from the license server. This setting corresponds to the LicenseID parameter in the CPF file.
MaxConsoleLogSize
Set the maximum size of the messages.log file. This setting corresponds to the MaxConsoleLogSize parameter in the CPF file.
MaxIRISTempSizeAtStart
Set the maximum size of the IRISTEMP database on restart. This setting corresponds to the MaxIRISTempSizeAtStart parameter in the CPF file.
ProcessHalt
Allow custom routines during foreground process shutdown. This setting corresponds to the ProcessHalt parameter in the CPF file.
ProcessStart
Allow custom routines during foreground process startup. This setting corresponds to the ProcessStart parameter in the CPF file.
ShutdownTimeout
Set the number of seconds InterSystems IRIS should wait until forcing a shutdown. This setting corresponds to the ShutdownTimeout parameter in the CPF file.
SystemHalt
Allow custom routines during system shutdown. This setting corresponds to the SystemHalt parameter in the CPF file.
SystemStart
Allow custom routines during system startup. This setting corresponds to the SystemStart parameter in the CPF file.
TempDirectory
Specify the subdirectory for temporary files. This setting corresponds to the TempDirectory parameter in the CPF file.
TerminalPrompt
Define the format of the terminal prompt. This setting corresponds to the TerminalPrompt parameter in the CPF file.
WebServer
Allow the web server to start. This setting corresponds to the WebServer parameter in the CPF file.
WebServerName
Set an IP address or a DNS name for the Web server. This setting corresponds to the WebServerName parameter in the CPF file.
WebServerPort
Set the web server port. This setting corresponds to the WebServerPort parameter in the CPF file.
WebServerURLPrefix
Identify the InterSystems IRIS instance name for the web server to access. This setting corresponds to the WebServerURLPrefix parameter in the CPF file.
ZSTU
Allow the user-defined startup to run. This setting corresponds to the ZSTU parameter in the CPF file.
Task Manager Email
See the Configuring Task Manager Email Settings section of the “Configuring InterSystems IRIS” chapter in System Administration Guide.


Previous section          
Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-20 05:47:55