docs.intersystems.com
InterSystems IRIS Data Platform 2019.2

Configuration Parameter File Reference
Next section
InterSystems: The power behind what matters   
Search:  


Preface : 
 
Chapter 1: 
 
1.1 Filename and Location
1.2 Editing the Active CPF file
       1.2.1 CPF File Format
1.3 Configuration Security
1.4 Multiple IRIS Configurations
1.5 Parameter Descriptions
Reference A: 
 
CommIPAddress — Define the IP address for cluster ECP traffic.
JoinCluster — Allow configuration to join a cluster.
Reference B: 
 
COMn — Define default settings for COM ports. Windows systems only.
Reference C: 
 
LibPath — Set the LD_LIBRARY_PATH environment variable. UNIX® systems only.
MaxServerConn — Set the maximum number of connections from ECP clients.
MaxServers — Set the maximum number of connections to ECP servers.
Path — Add directories to the default path environment variable. UNIX® systems only.
bbsiz — Set the maximum memory per process.
console — Set the path to the console log file (messages.log).
errlog — Set the maximum number of entries in the error log.
globals — Allocate shared memory for the global cache.
gmheap — Set the size of the generic memory heap.
history — Define command line recall options.
ijcbuff —  Set the size of an InterJob Communication buffer.
ijcnum — Set the number of InterJob Communication devices.
jrnbufs — Allocate memory for journal buffers.
locksiz — Set the maximum size of shared memory for locks.
memlock — Specify locking shared memory or the text segment into memory.
netjob — Allow remote job requests.
nlstab — Set the number of NLS collation tables.
overview — Review InterSystems IRIS platform and version summary.
pijdir — Set the Pre-Image Journal directory.
routines — Allocate shared memory for caching routine buffers.
udevtabsiz — Set the maximum size of the device table.
wijdir — Set the Write Image Journal files directory.
targwijsz — Set the desired size of the wij.
zfheap — Define the size and configuration of the $ZF heap.
Reference D: 
 
Version — Review the version of the configuration parameter file.
Reference E: 
 
Database — Define InterSystems IRIS databases.
Reference F: 
 
Dumpstyle — Specify the style of core dump.
Semsperset — Set number of semaphores allocated per set.
Reference G: 
 
Devices — Define device types.
Reference H: 
 
DeviceSubTypes — Define device subtypes.
Reference I: 
 
ClientReconnectDuration — Set duration for ECP reconnection attempt.
ClientReconnectInterval — Set interval between ECP reconnection attempts.
ServerTroubleDuration — Set the number of seconds an ECP connection stays in troubled state.
Reference J: 
 
ECPServers — Define ECP servers.
Reference K: 
 
Other — Set the default mnemonic for WRITE commands to device types other than terminal or sequential file.
File — Set the default mnemonic for WRITE commands to a sequential file.
Terminal — Set the default mnemonic for WRITE commands to a terminal device.
Reference L: 
 
AlternateDirectory — Set the alternate location of the journal file.
BackupsBeforePurge — Set the number of backups before InterSystems IRIS purges finished journal files.
CurrentDirectory — Set the primary location of the journal file.
DaysBeforePurge — Set the number of days before InterSystems IRIS purges finished journal files.
FileSizeLimit — Set the maximum size of a journal file.
FreezeOnError — Allow suspending InterSystems IRIS when an error occurs in writing to the journal.
JournalFilePrefix — Set a journal file name prefix.
JournalcspSession — Allow journaling of web sessions.
Reference M: 
 
LicenseServers — Define license servers.
Reference N: 
 
Global — Map globals to namespaces.
Package — Map packages to namespaces.
Routine — Map routines to namespaces.
Reference O: 
 
MapMirrors — Define mirror members for mirrors that include this instance.
Reference P: 
 
AgentAddress — Not in use.
AsyncMemberGUID — Review async member GUID
AsyncMemberType — Specify async type (Disaster recovery, read-only, or read-write).
AsyncUseSystemPurgeInterval — Specify how mirror journal files are purged on the reporting async member.
JoinMirror — Specify whether the instance processes its mirror configuration at startup.
SystemName — Set the name of the mirror member.
ValidatedMember — Specify whether the instance should join the mirror in its previous role or obtain its new role from the current primary before joining the mirror.
VirtualAddressInterface — Set the local interface which hosts the primary virtual IP address.
Reference Q: 
 
Mirrors — Define mirrors that include this instance.
Reference R: 
 
AsyncDisconnectErr — Allow processes to receive disconnect errors asynchronously.
AsynchError — Allow processes to receive asynchronous errors.
BreakMode — Specify programmer mode response to the BREAK command.
CollectResourceStats — Allow InterSystems IRIS to collect system resource statistics.
DisconnectErr — Specify how processes respond to a disconnect.
FileMode — Allow writing to a non-existent file.
GlobalKillEnabled — Allow KILL of an unsubscripted global.
IEEEError — Specify whether $DOUBLE returns INF and NAN values system-wide.
LineRecall — Allow command line recall for READ commands.
LogRollback — Allow logging for transaction rollbacks.
MVDefined — Not in use.
NodeNameInPid — Specify behavior when InterSystems IRIS references the special variable $JOB.
NullSubscripts — Allow null subscripts on global references.
OldZU5 — Specify whether to clear global vectors when switching namespace.
OpenMode — Specify read/write mode to use when opening sequential files.
PopError — Specify when to pop error handlers off the stack.
RefInKind — Specify how $NAME and $QUERY handle extended global references.
ScientificNotation — Allow lowercase "e" as scientific notation symbol system-wide.
SetZEOF — Specify the behavior when reading a sequential file and encountering an unexpected end-of-file error.
ShutDownLogErrors — Allow writing of InterSystems IRIS system error log entries to the messages.log file on shutdown.
StopID — Not in use.
SwitchOSdir — Disallow switching current working directories when changing namespaces.
SynchCommit — Disable synchronizing TCOMMIT with the corresponding journal write operation.
TelnetNUL — Suppress Telnet NUL at end-of-line for Telnet transmission. Windows systems only.
TruncateOverflow — Suppress the <MAXNUMBER> error on numeric overflow.
Undefined — Specify the response when ObjectScript attempts to fetch a variable that does not exist.
UseNagleAlgorithm — Allow InterSystems IRIS to use the Nagle algorithm for Telnet.
ViewPastData — Allow $VIEW to examine data outside of InterSystems IRIS memory area.
ZDateNull — Specify the $ZDATE response to an invalid value.
Reference S: 
 
SNMPEnabled — Allow automatic Simple Network Management Protocol (SNMP) startup.
Reference T: 
 
Namespace — Define InterSystems IRIS namespaces.
Reference U: 
 
AllowRowIDUpdate — Allow user to update RowID values.
ANSIPrecedence — Specify operator precedence for SQL queries.
AutoParallel — Allow parallel processing system-wide.
AutoParallelThreshold — Set the threshold for parallel processing.
BiasQueriesAsOutlier — Set query optimization to biased toward outliers.
Comment — Retain embedded SQL statements as comments in source code.
DBMSSecurity — Enable SQL security.
DDLDefineBitmapExtent — Specify whether a table created by a DDL statement defines a bitmap extent index.
DDLFinal — Specify whether a class created by a DDL statement is final.
DDLNo201 — Suppress error upon CREATE of a previously existing table.
DDLNo30 — Suppress error upon DROP of a nonexistent table.
DDLNo307 — Suppress error upon CREATE of a primary key constraint when one exists.
DDLNo311 — Suppress error upon ADD a foreign key, when a key of that name already exists.
DDLNo315 — Suppress error upon DROP of a nonexistent constraint.
DDLNo324 — Suppress error upon CREATE of a previously existing index.
DDLNo333 — Suppress error upon DROP of a nonexistent index.
DDLSQLOnlyCompile — Enable an SQL-only compile.
DDLUseExtentSet — Allow hashed names for globals that store index data of tables created by a DDL statement.
DDLUseSequence — Specify the function a table created by a DDL statement uses for ID assignment.
DefaultSchema — Set the default SQL schema name.
DelimitedIds — Enable interpreting double-quoted strings as delimited identifiers.
DropDelete — Specify whether DROP TABLE deletes the table’s data in addition to the table.
ECPSync — Ensure that the server and client cache are in sync.
ExtrinsicFunctions — Enable extrinsic functions in SQL statements.
FastDistinct — Allow SQL DISTINCT optimization.
IdKey — Set primary key constraint behavior.
IdTrxFrom — Define the From list of characters for Identifier Translation.
IdTrxTo — Define the To list of characters for Identifier Translation.
JavaClassPath — Define additional .jar files to load when the JDBC service is started.
JavaHome — Specify the Java version to use with the JDBC Gateway.
JDBCGatewayJVMArgs — Specify optional JVM arguments to use when starting the JDBC Gateway.
JDBCGatewayLog — Set the name of the JDBC Gateway log file.
JDBCGatewayPort — Set the port number for the JDBC Gateway.
JDBCGatewayUsePassphrase — Enable the passphrase requirement for JDBC connections.
LockThreshold — Set the SQL lock threshold.
LockTimeout — Set the SQL lock timeout.
ODBCVarcharMaxlen — Set the MaxLen for ODBC fields of type VarChar.
QueryProcedures — Specify whether all class queries project as SQL Stored Procedures.
RTPC — Enable Run Time Plan Choice (RTPC) query optimization.
ReferentialChecks — Enable foreign key constraint validation.
SaveMAC — Save the source code for cached query routines.
TCPKeepAlive — Set the number of seconds between keep-alive messages.
TimePrecision — Set the default time precision for SQL scalar time functions.
TODATEDefaultFormat — Set the default date format for the SQL TO_DATE() function.
Reference V: 
 
System Datatypes — Map SQL datatypes to their InterSystems IRIS equivalents.
Reference W: 
 
User Datatypes — Map SQL datatypes to their InterSystems IRIS equivalents.
Reference X: 
 
CallinHalt — Allow custom routines during callin close.
CallinStart — Allow custom routines during callin initialization.
CliSysName — Set the node name for the local system.
DBSizesAllowed — Specify possible database block sizes when creating a database.
DefaultPort — Set the port number for the InterSystems IRIS superserver.
DefaultPortBindAddress — Set the IP address for the InterSystems IRIS superserver to bind to.
EnableVSSBackup — Allow Volume Shadow Copy Service (VSS) backup. Windows systems only.
EnsembleAutoStart — Allow productions to auto-start when InterSystems IRIS starts.
ErrorPurge — Set the number of days to keep error globals.
FIPSMode — Enable FIPS 140–2 compliant library for database encryption on Red Hat Linux.
IPv6 — Allow InterSystems IRIS to accept IPv6 addresses.
JobHalt — Allow custom routines during background process (job) shutdown.
JobServers — Set the number of job servers.
JobStart — Allow custom routines during background process (job) startup.
LicenseID — Allow instance to requests a key from the license server.
MaxConsoleLogSize — Set the maximum size of the messages.log file.
MaxIRISTempSizeAtStart — Set the maximum size of the IRISTEMP database on restart.
ProcessHalt — Allow custom routines during foreground process shutdown.
ProcessStart — Allow custom routines during foreground process startup.
ShutdownTimeout — Set the number of seconds InterSystems IRIS should wait until forcing a shutdown.
SystemHalt — Allow custom routines during system shutdown.
SystemStart — Allow custom routines during system startup.
TempDirectory — Specify the subdirectory for temporary files.
TerminalPrompt — Define the format of the terminal prompt.
WebServer — Allow the web server to start.
WebServerName — Set an IP address or a DNS name for the Web server.
WebServerPort — Set the web server port.
WebServerURLPrefix — Identify the InterSystems IRIS instance name for the web server to access.
ZSTU — Allow the user-defined startup to run.
Reference Y: 
 
DNSLookup — Allow DNS lookup of the Telnet client address. Windows systems only.
Port — Set the Telnet port number. Windows systems only.
Appendix A: 
 
A.1 SQL and Object Settings
       A.1.1 SQL
       A.1.2 Objects
       A.1.3 TSQL Compatibility
       A.1.4 ISQL Compatibility
       A.1.5 System DDL Mappings
       A.1.6 User DDL Mappings)
A.2 National Language Settings
A.3 Device Settings
       A.3.1 Devices
       A.3.2 Device Subtypes
       A.3.3 IO Settings
       A.3.4 Telnet Settings
A.4 Additional Settings


Next 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-19 06:44:29