Home / Configuration Parameter File Reference

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

Preface : 
Chapter 1: 
1.1 Filename and Location
1.2 InterSystems IRIS Configurations
1.3 Specifying a CPF File
1.4 Editing the Active CPF File
1.5 Configuration Security
1.6 Parameter File Format
       1.6.1 Spaces
       1.6.2 Sections
       1.6.3 Parameters
1.7 Parameter Descriptions
1.8 List of Sections and Parameters
Reference A: 
JoinCluster — Join/decline cluster.
Reference B: 
COMn — Default settings for COM ports.
Reference C: 
LibPath — Sets the LD_LIBRARY_PATH environment variable. UNIX® systems only.
MaxServerConn — Maximum number of connections from ECP clients.
MaxServers — Maximum number of connections to ECP servers.
Path — Add to default path environment variable. UNIX® systems only.
bbsiz — Maximum memory per process.
console — Console log file.
errlog — Maximum number of entries in the error log.
globals — Size of shared memory for global cache.
gmheap — Size of the generic memory heap.
history — Command line recall.
ijcbuff — Size of an InterJob Communication buffer.
ijcnum — Number of InterJob Communication devices.
jrnbufs — Size of memory for journal buffers.
locksiz — Maximum size of shared memory for locks.
memlock — Enable/disable locking shared memory or the text segment into memory.
netjob — Enable/disable remote job requests.
nlstab — Number of NLS collation tables.
overview — InterSystems IRIS platform and version summary.
pijdir — Pre-Image Journal directory.
routines — Size of shared memory for caching routine buffers.
udevtabsiz — Maximum size of the device table.
wijdir — Write Image Journal files directory.
targwijsz — This value will set the desired size of the wij.
zfheap — Size and configuration of the $ZF heap.
Reference D: 
Version — Configuration parameter file version.
Reference E: 
Database — Define InterSystems IRIS databases.
Reference F: 
Dumpstyle — Style of core dump.
Reference G: 
Devices — Device types.
Reference H: 
DeviceSubTypes — Device subtypes.
Reference I: 
ClientReconnectDuration — How long to attempt ECP reconnection before giving up.
ClientReconnectInterval — Number of seconds to wait between ECP reconnection attempts.
ServerTroubleDuration — Number of seconds an ECP connection stays in troubled state.
Reference J: 
ECPServers — ECP servers.
Reference K: 
Other — Default mnemonic for WRITE commands to device types other than magnetic tape, terminal, or sequential file.
File — Default mnemonic for WRITE commands to a sequential file.
Terminal — Default mnemonic for WRITE commands to a terminal device.
Reference L: 
AlternateDirectory — Alternate location of the journal file.
BackupsBeforePurge — Number of backups before InterSystems IRIS purges finished journal files.
CurrentDirectory — Primary location of the journal file.
DaysBeforePurge — Number of days before InterSystems IRIS purges finished journal files.
FileSizeLimit — Maximum size of a journal file.
FreezeOnError — Enable/disable suspending InterSystems IRIS when an error occurs in writing to the journal.
JournalFilePrefix — Specify a journal file name prefix.
JournalcspSession — Enable/disable journaling of web sessions.
Reference M: 
LicenseServers — License servers.
Reference N: 
Global — Map globals to namespaces.
Package — Map a package to a specific namespace.
Routine — Map routines to namespaces.
Reference O: 
MapMirrors — Describes members of each mirror the instance is a member of.
Reference P: 
Mirrors — Describes mirrors the instance is a member of.
Reference Q: 
AgentAddress — Not in use.
AsyncMemberGUID — Async member GUID
AsyncMemberType — Indicates async type of DR, read-only, or read-write.
AsyncUseSystemPurgeInterval — Indicates how mirror journal files are purged on the reporting async member.
JoinMirror — Determines whether the instance processes its mirror configuration at startup.
SystemName — Mirror member name.
ValidatedMember — Determines 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 — Local interface to primary virtual IPaddress.
Reference R: 
AsyncDisconnectErr — Enable/disable a process to receive disconnect errors asynchronously.
AsynchError — Enable/disable processes to receive asynchronous errors.
BreakMode — Programmer mode response to the BREAK command.
CollectResourceStats — Controls whether system resource statistics are collected or not.
DisconnectErr — Enable/disable a process to receive disconnect errors.
FileMode — Enable/disable writing to a non-existent file.
GlobalKillEnabled — Enable/disable KILL of an unsubscripted global.
IEEEError — Enables or disables $DOUBLE returning INF and NAN values system-wide.
LineRecall — Enable/disable command line recall for READ commands.
LogRollback — Enable/disable logging for transaction rollbacks.
NodeNameInPid — Behavior when InterSystems IRIS makes a reference to the special variable $JOB.
NullSubscripts — Enable/disable null subscripts on global references.
OldZU5 — Clear global vectors when switching namespace.
OpenMode — Read/write mode to use when opening sequential files.
PopError — When to pop error handlers off the stack.
RefInKind — Result of $NAME and $QUERY when an extended global reference is the argument.
ScientificNotation — Enables or disables lowercase "e" as scientific notation symbol system-wide.
SetZEOF — Behavior when InterSystems IRIS encounters an unexpected end-of-file when reading a sequential file.
ShutDownLogErrors — Enable/disable writing of InterSystems IRIS system error log entries (see InterSystems IRIS System Error Log in the Monitoring InterSystems IRIS Using the Management Portal chapter of the Monitoring Guide) to the messages log file on shutdown.
SwitchOSdir — Enable/disable switching current working directories when changing namespaces.
SynchCommit — Enable/disable synchronizing TCOMMIT with the corresponding journal write operation.
TelnetNUL — Suppress/issue Telnet NUL at end-of-line for Telnet transmission. Windows only.
TruncateOverflow — Enable/disable the <MAXNUMBER> error on numeric overflow.
UseNagleAlgorithm — Enable/disable the Nagle algorithm for Telnet.
ViewPastData — Enable $VIEW to examine data outside of InterSystems IRIS memory area.
ZDateNull — $ZDATE response to an invalid value.
Reference S: 
SNMPEnabled — Enable/disable automatic SNMP startup.
Reference T: 
Namespace — Define InterSystems IRIS namespaces.
Reference U: 
AllowRowIDUpdate — Enable/disable SQL row ID update.
ANSIPrecedence — Enable/disable ANSI SQL operator precedence system-wide.
AutoParallel — Enable/disable parallel processing system-wide.
AutoParallelThreshold — Set the threshold for parallel processing.
BiasQueriesAsOutlier — Enable/disable query optimization biased toward outliers.
Comment — Enable/disable retaining embedded SQL statements as comments in source code.
DBMSSecurity — Enable/disable SQL security.
DDLDefineBitmapExtent — Determines whether a table created by a DDL statement defines a bitmap extent index.
DDLFinal — Determines whether a class created by a DDL statement is final.
DDLNo201 — Suppress/return error upon CREATE of a previously existing table.
DDLNo30 — Suppress/return error upon DROP of a nonexistent table.
DDLNo307 — Suppress/return error upon CREATE of a primary key constraint when one exists.
DDLNo311 — Suppress/return error upon ADD a foreign key, when a key of that name already exists.
DDLNo315 — Suppress/return error upon DROP of a nonexistent constraint.
DDLNo324 — Suppress/return error upon CREATE of a previously existing index.
DDLNo333 — Suppress/return error upon DROP of a nonexistent index.
DDLSQLOnlyCompile — Enable/disable an SQL-only compile.
DDLUseExtentSet — Enable/disable hashed names for globals that store index data of tables created by a DDL statement.
DDLUseSequence — Determines which function a table created by a DDL statement uses for ID assignment.
DefaultSchema — Set the default SQL schema name.
DelimitedIds — Enable/disable interpreting double-quoted strings as delimited identifiers.
DropDelete — Determines DROP TABLE behavior.
ECPSync — Ensures that the server and client cache are in sync.
ExtrinsicFunctions — Enable/disable extrinsic functions in SQL statements.
FastDistinct — Enable/disable SQL DISTINCT optimization.
IdKey — Determines primary key constraint behavior.
IdTrxFrom — Provides the “From” list of characters for Identifier Translation.
IdTrxTo — Provides the “To” list of characters for Identifier Translation.
JavaClassPath — Lists additional .jar files to load when the JDBC service is started.
JavaHome — Specifies the Java version to use with the JDBC Gateway.
JDBCGatewayJVMArgs — Specifies optional JVM arguments to use when starting the JDBC Gateway.
JDBCGatewayLog — Specify the name of the JDBC Gateway log file.
JDBCGatewayPort — Set the port number for the JDBC Gateway.
JDBCGatewayUsePassphrase — Enable/disable the passphrase requirement for JDBC connections.
LockThreshold — Set the SQL lock threshold.
LockTimeout — Set the SQL lock timeout.
ODBCVarcharMaxlen — Define the MaxLen for ODBC fields of type VarChar.
QueryProcedures — Defines whether all class queries project as SQL Stored Procedures.
RTPC — Enable/disable Run Time Plan Choice (RTPC) optimization.
ReferentialChecks — Enable/disable validating the foreign key constraint.
SaveMAC — Enable/disable saving 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-Defined SQL Datatypes — Map SQL datatypes to their InterSystems IRIS equivalents.
Reference W: 
User-Defined SQL Datatypes — Map SQL datatypes to their InterSystems IRIS equivalents.
Reference X: 
CallinHalt — Callin close.
CallinStart — Callin initialization.
CliSysName — Node name for the local system.
DBSizesAllowed — Database block sizes allowed when creating a database.
DefaultPort — Port number for the InterSystems IRIS Superserver.
DefaultPortBindAddress — IP address for the InterSystems IRIS Superserver to bind to.
EnableVSSBackup — Enable/disable Volume Shadow Copy Service (VSS) backup.
EnsembleAutoStart — Start the productions when InterSystems IRIS starts.
ErrorPurge — Number of days to keep error globals.
FIPSMode — Enable/disable FIPS 140–2 compliant library for database encryption on Red Hat Linux.
IPv6 — Enable/disable IPv6 network with IPv6 addresses.
JobHalt — Background process (job) shutdown.
JobServers — Number of job servers.
JobStart — Background process (job) startup.
MaxConsoleLogSize — Maximum size of the messages log file.
MaxIRISTempSizeAtStart — Maximum size of database on restart.
ProcessHalt — Foreground shutdown.
ProcessStart — Foreground startup.
ShutdownTimeout — Number of seconds InterSystems IRIS should wait for shutdown to complete.
SystemHalt — System shutdown.
SystemStart — System startup.
TempDirectory — Subdirectory for temporary files.
TerminalPrompt — Sets the format of the terminal prompt.
WebServer — Start or don't start the Web server.
WebServerName — Sets an IP address or a DNS name on the Web server.
WebServerPort — Set the Web server port.
WebServerURLPrefix — Identify the InterSystems IRIS instance name so that a remote Web server can access it.
ZSTU — User-defined startup.
Reference Y: 
DNSLookup — (Windows) Enable/disable DNS lookup of the Telnet client address.
Port — Telnet port number.

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-07-19 06:48:23