Caché Additional Configuration Settings Reference
Caché Additional Configuration Settings
[Home] [Back] 
InterSystems: The power behind what matters   
Class Reference   
Search:    

This chapter describes some configuration settings that are available from the System Administration > Configuration page in the Management Portal.

Under the System Administration > Configuration page are the options:
Under the System Administration > Configuration > Additional Settings page are the options:
Advanced Memory Settings
The Advanced Memory page (System Administration > Configuration > Additional Settings > Advanced Memory) contains a number of memory-related and other settings, as listed in the following.
Important:
The Memory and Startup page (System Administration > Configuration > System Configuration > Memory and Startup) lets you allocate memory to routine and databases caches; when Caché is first installed, this cache allocation is set to Automatically. This 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 Caché” chapter of the Caché System Administration Guide.
BackoffDisabled
On failure to allocate memory, do not retry with reduced amount. If the memory cannot be allocated as its configured size, startup is aborted. For more information see the memlock entry in the List of Sections and Parameters section of the “Caché Parameter File Reference”.
ConsoleFile
File in which to log system console messages. If no value is specified for ConsoleFile, Caché writes to the file cconsole.log in the Caché system management directory. See MaxConsoleLogSize.
The ConsoleFile and MaxConsoleLogSize settings apply on all platforms. On OpenVMS only, there is also a VMSConsoleTerminal setting, which may be set to the name of a terminal device for message logging.
LargePagesDisabled
On platforms supporting large pages or huge pages, disable use of them for shared memory. For more information, see the memlock entry in the List of Sections and Parameters section of the “Caché Parameter File Reference”.
LargePagesRequired
On platforms supporting large or huge pages (Windows, AIX, and Linux), require use of them for shared memory. For more information, see the memlock entry in the List of Sections and Parameters section of the “Caché Parameter File Reference”.
LibPath
UNIX® systems only. Sets the LD_LIBRARY_PATH environment variable to paths to search for third-party shared libraries. If you modify this setting, you must restart the system to make it active.
LineRecallBuffer
Total size (in bytes) of all input strings to be stored in the command line/read line buffer. The default is 1024 bytes. The range is 0–8192 bytes. See LineRecallEntries.
If you edit this setting, you must restart Caché to apply the change.
LineRecallEntries
Maximum number of entries held in the command line/read line recall buffer, subject to the space limitation in the LineRecallBuffer setting. The default is 32 entries. The range is 0–256 entries.
If you edit this setting, you must restart Caché to apply the change.
LockSharedMemory
True or false. When true, shared memory is locked in memory to prevent paging. The default is false. If you edit this setting, you must restart Caché to apply the change. For more information, see the memlock entry in the List of Sections and Parameters section of the “Caché Parameter File Reference”.
LockTextSegment
True or false. When true, the text segment (the Caché executable code space) is locked into shared memory. The default is false. If you edit this setting, you must restart Caché to apply the change. For more information, see the memlock entry in the List of Sections and Parameters section of the “Caché Parameter File Reference”.
MaxServerConn
Maximum number of ECP clients that can access this system simultaneously. This is the maximum number of connections that this system may accept when acting as an ECP server. The range is 0–254 clients. The default is 1 client.
If you edit this setting, you must restart Caché to apply the change.
MaxServers
Maximum number of ECP servers that can be accessed from this system. This is the maximum number of connections that this system can establish when acting as an ECP client. The range is 0–254 servers. The default is 2 servers.
Path
(UNIX only.) The default Path used for all processes started during cache startup is Path=/usr/bin:/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin. You can append more directories to this path using the Path variable.
All the processes started during Phase 2 of Startup (which runs the STU1.mac routine) search in the base Path followed by any directories that you add to the Path here.
VMSConsoleTerminal
Name of the console terminal device for logging messages on an OpenVMS system. If none is specified, the terminal device OPA0: is used.
If you edit this setting, you must restart Caché to apply the change.
ZFSize
The $ZF heap is used for output parameters in a callout function using $ZF. For details, see the chapter Creating a Caché Callout Library in Using the Caché Callout Gateway.
Two parameters configure the $ZF heap: ZFString and ZFSize.
The formula for calculating ZFSize based on ZFString is as follows:
ZFSize = (BytesPerCharacter * ZFString) + 2050
For example, suppose ZFString has the default value, 32767:
If you edit this setting, you must restart Caché to apply the change.
ZFString
The $ZF heap is used for output parameters in a callout function using $ZF. For details, see the chapter Creating a Caché Callout Library in Using the Caché Callout Gateway.
Two parameters configure the $ZF heap: ZFString and ZFSize.
If you edit this setting, you must restart Caché to apply the change.
errlog
Maximum number of entries in the Caché system error log (see Caché System Error Log in the “Monitoring Caché Using the Management Portal” chapter of the Caché Monitoring Guide for more information). The log file expires old entries as this limit is reached. On OpenVMS the default maximum is 1000 entries, otherwise the default is 500 entries. The range is 10–10000 entries.
If you edit this setting, you must restart Caché to apply the change.
gmheap
Size (in kilobytes) of the generic memory heap (also known as the shared memory heap or SMH) for Caché.
The gmheap setting configures total shared memory available for use by the subsystems of a Caché instance. Shared memory is allocated from this total as needed for particular purposes (such as global mapping, database name and directory information, the security system, and so on). The shared memory in use by a given subsystem at a given time may be less than what is currently allocated.
Shared memory allocation is shown on the Shared Memory Heap Usage page (navigate to the System Operation > System Usage page and click the Shared Memory Heap Usage link); see Generic (Shared) Memory Heap Usage in the “Monitoring Caché Using the Management Portal” chapter of the Caché Monitoring Guide for more information. Although this page displays memory allocation and use in bytes, bearn in mind that shared memory is allocated in pages.
The default size of gmheap is 37568 kb (53952 kb for IBM AIX® and HP-UX). (Note that in some cases, the actual maximum amount of shared memory available for allocation may be more than what is specified by gmheap. For example, more than the amount specified may be allocated to compensate for the needs of multiple CPUs.)
Under some circumstances it may be necessary to increase gmheap to make enough shared memory available, for example in the following situations:
The locksiz setting configures the portion of total available shared memory that can be specifically allocated for managing locks (the lock table). locksiz is a subset of gmheap, and the remainder of gmheap is what is available for all other subsystems, so it is important that gmheap and locksiz be sized in consideration of this relationship, and that when locksiz is increased, gmheap is also increased proportionally.
If you edit the gmheap setting, you must restart Caché to apply the change.
For an in-depth look at Caché memory planning by an InterSystems senior technology architect, see InterSystems Data Platforms and Performance Part 4 - Looking at Memory on InterSystems Developer Community.
ijcbuff
Number of bytes allocated for each InterJob Communication (IJC) buffer. The default is 512 bytes. The range is 512–8192 bytes. For details, see the Interprocess Communication chapter in the Caché I/O Device Guide. Also see ijcnum.
If you edit this setting, you must restart Caché to apply the change.
ijcnum
Number of InterJob Communication (IJC) devices. Each device corresponds to one InterJob Communication buffer of the size defined by ijcbuff. The default is 16 devices. The range is 0–256 devices. For details, see the Caché I/O Device Guide chapter Interprocess Communication.
If you edit this setting, you must restart Caché to apply the change.
locksiz
Size (in bytes) of shared memory allocated for locks. The system rounds up the value to the next multiple of 64 kilobytes. The default is 1179648 bytes. (On the IBM AIX and HP-UX platforms, the default is 33554432 bytes.) This setting is a subset of the shared memory allocated for all purposes by the gmheap setting; the range is 65536 bytes up to the gmheap setting, but as a practical matter locksiz should be only a fraction of gmheap so that shared memory is available for other purposes. If you need more room for the lock table, increase gmheap and then increase locksiz.
If you edit this setting, changes take place immediately.
netjob
Allow remote job requests to run on this server.
If you edit this setting, changes take place immediately.
nlstab
Enter the maximum number of collation tables, from 0–64. The default is 30. This instructs Caché to reserve space for that many tables at startup.
If you edit this setting, you must restart Caché to apply the change.
udevtabsiz
Maximum size (in bytes) of the device table. This is the table that maps device numbers (traditional logical unit numbers) to device names, so that ObjectScript code can open devices by number. The default is 24576 bytes. The range is 0–65535 bytes.
If you edit this setting, you must restart Caché to apply the change.
useresidentmem
(OpenVMS only) Name of a reserved resident memory section. If blank, no reserved resident memory section is used.
For details about configuring Caché to run on OpenVMS, see the Calculating System Parameters for OpenVMS appendix in the Caché Installation Guide.
If you edit this setting, you must restart Caché to apply the change.
vectors
Deprecated. No longer used by Caché.
Compatibility Settings
The Compatibility page (System Administration > Configuration > Additional Settings > Compatibility) contains the following settings:
ASyncDisconnectErr
This setting modifies the behavior of Caché when DisconnectErr is enabled.
AsyncDisconnectError is only applicable to Telnet connections on Windows. It has no effect on any other device type or operating system. If DisconnectErr is false, then AsyncDisconnectError has no effect.
AsynchError
Enable (selected) or disable (cleared) processes to receive asynchronous errors.
BreakMode
True (selected) or false (cleared). Programmer mode response to the BREAK command.
Caché programs can execute in two modes, depending on how Caché is entered: application mode and programmer mode.
The BreakMode setting controls how a Caché process in programmer mode responds when it encounters a BREAK command that has no argument.
Application mode jobs always ignore BREAK commands with no arguments.
CollectResourceStats
Controls whether system resource statistics are updated or not (seize, nseize, aseize, bseize). The default is that they are not collected.
For more information on system resource statistics, see the appendixes Monitoring Caché Using the cstat Utility and Monitoring Caché Using Web Services (Enumresource) in the Caché Monitoring Guide.
DisconnectErr
How Caché responds to a disconnect of the principal I/O device.
Note that, if ErrorOnDisconnect is enabled, a process continues to execute after its principal device has been disconnected. It is the responsibility of the application to detect the disconnect condition and exit gracefully.
Use care when enabling ErrorOnDisconnect. The application must be prepared to recognize the <DSCON> error and handle it appropriately in error traps.
ErrorOnDisconnect is only applicable to TCP devices and to terminal devices where a disconnect can be recognized. Examples are modem controlled terminals and Windows Telnet, and Windows local cterm (TRM:) connections. ErrorOnDisconnect is only applicable to the principal device.
FileMode
Create a file if it does not exist when called with Write or Read/Write.
Suppose Caché encounters an OPEN command such as:
OPEN "file.x":"WS"
When FileMode is true, the new file is created automatically even though the N parameter is not specified with the OPEN command. The result when FileMode is true is equivalent to adding the N parameter to each OPEN command, so that:
OPEN "file.x":"WS"
is equivalent to:
OPEN "file.x":"WNS"
On the other hand, when Caché encounters an OPEN command and no N parameter is provided and the file does not already exist, then if FileMode is false there is no result from the OPEN command except that the process hangs until interrupted.
On OpenVMS systems, the default FileMode is true; on all other platforms the default FileMode is false.
GlobalKillEnabled
Deprecated. Enable (selected) or disable (cleared) KILL of an unsubscripted global.
IEEEError
Enables or disables $DOUBLE returning INF and NAN values system-wide. This property sets the $DOUBLE function return-value behavior system-wide.
The property controls the issuing of INF, -INF, and NAN when a $DOUBLE numeric operation cannot be resolved to a numeric value. It does not control the issuing of INF, -INF, and NAN in all cases. $DOUBLE always returns INF, -INF, or NAN when you supply one of these strings as the input value, regardless of this property. Mathematical operations on $DOUBLE numbers that result in an INF, -INF, or NAN are controlled by this property. These include arithmetic operations, exponentiation, and logarithmic and trigonometric functions.
LineRecall
Enable (selected) or disable (cleared) command line recall for READ commands.
The selection determines whether the line recall feature is active only for command prompts, or for both command prompts and READ commands.
LogRollback
Enable (selected) or disable (cleared) logging for transaction rollbacks.
MVDefined
Sets MVBasic handling of undefined variables system-wide. This setting defines MVBasic behavior when it encounters a reference to an undefined variable.
NodeNameInPid
Defines the behavior when Caché makes a reference to the special variable $JOB.
NullSubscripts
Allow (selected) null subscripts on global references
OldZU5
OpenMode
0 or 1 specifies the read/write mode to use when opening sequential files and no mode is specified in the OPEN command.
PopError
Defines when to pop error handlers off the stack.
True (selected) - Pop the $ZTRAP error handler off the stack when an error is triggered (DSM compatibility mode)
False - (cleared) Normal behavior: A $ZTRAP error handler stays active when the error handler is invoked. (default)
When a $ZTRAP error handler is invoked by the system, that error handler remains on the stack of established error handlers. Thus, if an error occurs when the error handler is executing, that error handler attempts to invoke itself, receives the same error again, and enters an infinite loop, unless that error handler explicitly sets $ZTRAP to a new value. When a $ZTRAP error handler is invoked in DSM, the error handler is removed from the stack. Thus, if an error occurs while the error handler is executing, that error is handled by the previous error handler on the stack.
RefInKind
Determines the result of $NAME and $QUERY when an extended global reference is given as the argument.
If you change the value of this parameter, the change applies to processes started after the change, but not for processes that were already running when you made the change.
ScientificNotation
This setting enables or disables using the lowercase "e" as scientific notation symbol system-wide.
SetZEOF
Determines the behavior when Caché encounters an unexpected end-of-file when reading a sequential file.
ShutDownLogErrors
This setting controls Caché behavior during execution of its SHUTDOWN procedure.
StopID
Sets $ZF process deletion behavior for OpenVMS STOP/ID system-wide. On OpenVMS systems only.
Using the OpenVMS STOP/ID command to delete a process can cause your system to fail. For this reason, on OpenVMS systems, by default, Caché prevents you from deleting processes with STOP/ID. For processes that are executing $ZF functions, you may need to be able to delete a process from OpenVMS. Set this value to 0 if you need to terminate processes in a $ZF function.
SwitchOSdir
Specifies what happens to the current working directory (for accessing files by relative pathname, etc.) when you switch to a new namespace.
Suppose SwitchOSDirectory is set to false, or SwitchOSDirectory is set to true and the dataset is remote. In these cases, the current working directory does not change automatically as a result of changing the namespace, but you can always change the current working directory programmatically, using the $ZUTIL(168) function. $ZUTIL(168) works even when automatic switching during a namespace change has been inhibited. $ZUTIL(168) returns the name of the current working directory, and $ZUTIL(168,directory) sets the current working directory to the specified directory name regardless of the value of SwitchOSDirectory.
SynchCommit
Every TCOMMIT command requests a flush of the journal data involved in that transaction to disk.
TelnetNUL
Suppress/issue Telnet NUL at end-of-line during Telnet transmission. On output, a Telnet network virtual terminal (NVT) performs the following default end-of-line behavior: either issues a CR (carriage return character) followed by a LF (linefeed character), or issues a CR followed by a NUL character (if no LF is issued). The TelnetNUL setting affects the issuance of the NUL character in the second case. (This setting applies only to Windows; it has no effect on UNIX®, Linux, or OpenVMS configurations, in which Telnet is supplied by the operating system vendor.)
TruncateOverflow
Enable (cleared) or disable (selected) the <MAXNUMBER> error on numeric overflow.
Normally, when Caché encounters a number larger than 92372036854775807 E127 (or smaller than -9223372036854775808 E127) it throws the <MAXNUMBER> error. You can prevent this by selecting the TruncateOverflow setting.
Undefined
Specifies how ObjectScript reacts when it attempts to fetch the value of a variable that has not been defined.
UseNagleAlgorithm
Enable (selected) or disable (cleared) the Nagle algorithm for Telnet.
The Nagle algorithm makes Telnet more efficient. It reduces the number of IP packets sent over the network by consolidating messages that are sent within a small time interval into a single IP packet. For details see http://www.ietf.org/rfc/rfc896.txt
ViewPastData
Enable $VIEW command to examine data outside of Caché memory area.
ZDateNull
Determines how a $ZDATE call responds when triggered by an invalid value.
ZaMode
Determines how the ZALLOCATE (ZA) and ZDEALLOCATE (ZD) commands behave, according to Caché rules or DSM-11 rules:
For details, see the section DSM-11 Language Compatibility in the “Open M Language Compatibility” chapter of Using Caché ObjectScript.
Device Settings
The Device Settings menu (System Administration > Configuration > Device Settings) contains the following settings:
Devices
The Devices page (System Administration > Configuration > Device Settings > Devices) contains the following settings:
Devices
List of devices configured for this installation.
—Edit or Add Device Configuration Fields—
Alias-An alternate device ID for this device. All aliases must be unique. You can use this value as the device argument in an OPEN command.
AlternateDevice-The device ID of another device. The value entered for AlternateDevice must be a defined mnemonic such as the Name supplied for another device.
Specifying an AlternateDevice value for the device allows users of the %IS utility to specify “A” to tell Caché to use the alternate device. %IS is a general device selection utility for character-based applications. For details about %IS see the section Allowing Users to Specify a Device in the “I/O Devices and Commands” chapter of the Caché I/O Device Guide. The topic of most interest is %IS Mnemonics,” which describes the conventions for entering the “A” code for %IS.
Description-A text description of where the device is located. This field is for your own reference to help you identify what machine you are configuring.
Name-The mnemonic that is the defined device title or number.
OpenParameter-A colon-separated string that provides the parameters, timeout, and mnespace arguments for this device’s OPEN command. The syntax for the OpenParameter string is:
(parameters):timeout:"mnespace"
Inside the parentheses for parameters, individual items are colon-separated, as follows:
param1:param2:param3
Resulting in:
(param1:param2:param3):timeout:"mnespace"
timeout and mnespace are optional, but if they are provided, the correct number of colons must separate them from previous entries in the OpenParameter string.
parameters must be contained within parentheses only if there is more than one parameter. If there are no parameters, or if there is only one parameter, the parentheses may be omitted from the string. Thus the following is a correct and complete OpenParameter string:
:timeout:"mnespace"
If provided, mnespace must be contained within double quotes, as shown.
For details about the OPEN command and its arguments, including a large variety of syntax examples, see the Caché ObjectScript Reference.
PhysicalDevice-The physical name used to refer to the device. The PhysicalDevice value specifies the device argument for this device’s OPEN command. The name can contain up to 128 alphanumeric characters; it can contain space characters as well. For example, for a printer you could enter the following, where MYNAME is the computer name.
|PRN|\\MYNAME\ISF-HP5SiMX7
Or:
|PRN|\\MYNAME\Canon PIXMA
Prompt-Choose an option: Show device prompt (the user sees the device selection prompt with the default device defined). Auto-use this device if it is the current device. Auto-use this device with predefined settings.
SubType-Used to refine the definition of your device subtypes. SubTypes specify terminal characteristics. They are used to create the appropriate OPEN command for the device. There should be subtype information for every terminal type.
Type-The type of device. Options: TRM=Terminal. SPL=Spooling device. MT=Magnetic Tape drive. BT=Cartridge tape drive. OTH=Any other device including printers and sequential files. The default depends on the device type.
The maximum length of most strings above is 128 characters. The exception is the Description string, which may be 256 characters long.
Magnetic Tape Devices
The Magnetic Tape Devices page (System Administration > Configuration > Device Settings > Magnaetic Tape Devices) contains the following settings:
MagTapes
List of magnetic tape devices configured for this installation.
—Configuration Fields—
Name-The pathname to the device in the system. This string may be up to 128 characters long.
System Device-The name of the physical tape device.
Device SubTypes
The Device SubTypes page (System Administration > Configuration > Device Settings > Device SubTypes) contains the following settings:
SubTypes
List of device subtypes configured for this installation.
—Configuration Fields—
Backspace-The ASCII code that represents the backspace character on the selected device in the form $C(code1). This setting is used by the Caché CHUI utilities.
CursorControl-The ASCII code that represents the cursor on the selected device in the form $C(code1).
EraseEOF-The ASCII code that represents erasing the end of file character on the selected device in the form $C(code1,code2...).
EraseEOL-The ASCII code that represents erasing the end of line characters on this device in the form $C(code1,code2).
FormFeed-The ASCII code that represents a form feed on the selected device in the form #,$C(code1,code2...). This setting is used by the Caché CHUI utilities.
Name-The name of the sub-type.
RightMargin-The number that represents the location of the right margin. Device output will wrap at that number of characters.
ScreenLength-The number of lines that comprise one screen or page for the device.
ZU22Backspace-The ASCII code that represents a backspace on the selected device in the form $C(code1). This setting is used by Caché for Terminal output.
ZU22FormFeed-The ASCII code that represents a form feed on the selected device in the form $C(code1,code2). This setting is used by Caché for Terminal output.
All default values depend on the device type.
IO Settings
The IO Settings page (System Administration > Configuration > Device Settings > IO Settings) contains the following settings:
File
Default for WRITE commands to a sequential file. When an OPEN or USE command includes no space argument, Caché uses the default for that device type. ^%X364 is the default space for a sequential file. You can use this default, or reset it as needed. See the Controlling Devices with Mnemonic Spaces chapter in the Caché I/O Device Guide.
If you edit this setting, the change applies automatically the next time you restart Caché.
MagTape
Default for WRITE commands to magnetic tape. When an OPEN or USE command includes no space argument, Caché uses the default for that device type. ^%XMAG is the default space for magnetic tape. You can use this default, or reset it by changing the value of as needed. See the Controlling Devices with Mnemonic Spaces chapter in the Caché I/O Device Guide.
If you edit this setting, the change applies automatically the next time you restart Caché.
Other
Default for WRITE commands to device types other than magnetic tape, terminal, or sequential file. When an OPEN or USE command includes no space argument, Caché uses the default for that device type. ^%X364 is the default space for device types other than magnetic tape, terminal, or sequential file. You can use this default, or reset it as needed. See the Controlling Devices with Mnemonic Spaces chapter in the Caché I/O Device Guide.
If you edit this setting, the change applies automatically the next time you restart Caché.
Terminal
Default for WRITE commands to a terminal device. When an OPEN or USE command includes no space argument, Caché uses the default for that device type. ^%X364 is the default space for a terminal. You can use this default, or reset it as needed. See the Controlling Devices with Mnemonic Spaces chapter in the Caché I/O Device Guide.
If you edit this setting, the change applies automatically the next time you restart Caché.
Telnet Settings
Caché Telnet settings apply only to Windows configurations in which InterSystems supplies the Telnet servers. They do not apply to UNIX®, Linux, or OpenVMS 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:
DNS Lookup
On or Off. This setting enables or disables DNS lookup of the client address in the telnet daemon before passing the address to the Caché process that was created to service the connection. This determines the format of the client address returned by $IO and $ZIO in the Caché process. When on, a DNS lookup of the client address is performed, and the client name is passed to Caché. When off, no DNS lookup is performed, and the client address is provided in dotted decimal format. The default is true.
DNS lookup should be turned off if a DNS server is not available to do the lookup, because a long delay occurs during login if the DNS server is not available.
If you edit this setting, you must restart Caché to apply the change.
Telnet Port Number
TCP/IP port number for Telnet connections. The default port number is 23. If multiple Caché configurations are to run on the same host at the same time, a different Telnet port number must be specified for each running configuration. Clients can attach to configurations using the non-default port number by specifying the port number when they invoke Telnet on the client system. Telnet, with or without SSL, can be configured on any port; it does not require the use of port 992.
If you edit this setting, you must restart Caché to apply the change.
Monitor Settings
The Monitor Settings page (System Administration > Configuration > Additional Settings > Monitor) contains the following settings:
Start Patrol at System Startup
When you select Yes, the connection to PATROL starts automatically whenever Caché starts up. The default is No. When you edit this setting, the Caché end of the PATROL interface immediately stops and starts. For more information, see the appendix Monitoring Caché Using BMC PATROL in the Caché Monitoring Guide.
Patrol Top Processes to Monitor
Number of processes displayed in the Process Status window on the PATROL console. This window shows the top processes as sorted by global or routine activity. The default number of processes is 20. A value of 0 tells the PATROL utility to stop calculating the top processes, potentially saving significant work on systems with many processes. The valid range is 1-10000 processes.
Patrol Display Mode
Controls how the monitoring data is displayed in the PATROL console. The default option is Total. Options are as follows:
Patrol Collection Interval Seconds
Number of seconds between each time Caché collects data and makes it available to PATROL. The default is 30 seconds; the valid range is 1-900 seconds.
Start SNMP Agent at System Startup
To enable SNMP monitoring, select Yes for this setting. You must also have the %Service_Monitor enabled on the [Home] > [Security Management] > [Services] page. For more information, see Monitoring Caché Using SNMP in the Caché Monitoring Guide
WMI Enabled
Select Yes to use WMI to collect Caché information. You must also enable the Caché monitoring service. For more information, see Monitoring Caché Using WMI in the Caché Monitoring Guide.
National Language Settings
The National Language Settings page (System Administration > Configuration > National Language Settings) contains the following settings:
For more information, see Configuring NLS Settings in the Caché System Administration Guide.
Locale Definitions
The Locale Definitions page (System Administration > Configuration > National Language Settings > Locale Definitions) contains the following settings:
Locale Definitions
To view and edit details of a selected locale, select Properties. The next page displays the locale properties grouped into categories. For each category you can edit the fields and select Save, or select Return at the top of the page to cancel any of your edits and return to the Locale Properties page. The properties are grouped into the following tables:
Import Locales or Tables
The Import Locale page (System Administration > Configuration > National Language Settings > Import Locales or Tables) contains the following settings:
Import Locale
  1. Select the Import Type; Locale is the default.
  2. Enter a file name and select OK. The only valid file extensions are .xml and .goq.
  3. A message displays indicating how many locales, tables, and subtables have been imported.
Source Control Settings
The Source Control Settings page (System Administration > Configuration > Additional Settings > Source Control) contains the following settings. For more information on Source Control see the appendix Using Studio Source Control Hooks in Using InterSystems Development Environments — Atelier and Studio.
NAMESPACES
  1. To set a source control for a namespace, select the namespace.
  2. Select a source control class and select OK.
SQL and Object Settings
The SQL and Object Settings menu (System Administration > Configuration > SQL and Object Settings) contains the following settings:
General SQL Settings
The General SQL Settings page (System Administration > Configuration > SQL and Object Settings > General SQL Settings) contains the following settings.
Selecting a checkbox sets a Yes value; clearing a checkbox sets a No value. If you set one or more configuration options, the General SQL Settings label will be followed by an asterisk, indicating that changes have been made but not yet saved. You must press the Save button for configuration changes to take effect.
Caché includes support for the following SQL configuration settings. They are grouped by their General SQL Settings tab, and listed in alphabetical order.
Many of the same options can also be displayed by invoking $SYSTEM.SQL.CurrentSettings() method.
You can also manage SQL system data types and user data types by selecting System Administration > Configuration > SQL and Object Settings, then either System-defined DDL Mappings or User-defined DDL Mappings.
SQL Tab
All Class Queries Project as Stored Procedures:
Yes or No. When Yes, all SQL class queries project as SQL Stored Procedures, regardless of the query’s SqlProc value. When No, only those SQL class queries with SqlProc=TRUE are projected as SQL Stored Procedures. The default is No. You can also set this option using the $SYSTEM.SQL.SetQueryProcedures() method.
Allow Extrinsic Functions in SQL Statements:
Yes or No. When Yes, extrinsic functions can be used in SQL statements through ODBC, JDBC, and Dynamic Query. The default is No. Changing this option causes the purging of all cached queries in all namespaces. You can also set this option using the $SYSTEM.SQL.SetAllowExtrinsicFunctions() method.
For further details, refer to the SELECT command.
Cached Query - Save Source:
Yes or No. When Yes, the source code (.MAC and .INT) for cached query routines created through Dynamic SQL is saved. When No, the source code is not saved. The default is No. You can also set this option using the $SYSTEM.SQL.SetCachedQuerySaveSource() method.
Default SQL Schema Name:
String defining the default schema name. The maximum length of the string is 128 characters. The default string is: SQLUser. The default schema name comes into play when an unqualified table name is encountered in an SQL statement and there is no #import statement specified. This setting has nothing to do with the mappings between SQL schema names and the class package name; it only specifies the default schema name. If you specify _CURRENT_USER as the default schema name, the default schema name becomes the username of the currently logged-in process or, if the process has not logged in, SQLUser becomes the default schema name. If you specify _CURRENT_USER/name as the default schema name, where name is any string of your choice, then the default schema name becomes the username of the currently logged-in process or, if the process has not logged in, name is used as the default schema name. For example, _CURRENT_USER/HMO uses HMO as the default schema name if the process has not logged in. Changing this option causes the purging of all cached queries in all namespaces. You can also set this option using the $SYSTEM.SQL.SetDefaultSchema() method.
For further details, refer to the CREATE TABLE and CREATE VIEW commands.
Default time precision for GETDATE(), CURRENT_TIME, and CURRENT_TIMESTAMP:
Default time precision for the Time component of the value returned by the SQL scalar functions GETDATE, GETUTCDATE, CURRENT_TIME, and CURRENT_TIMESTAMP. The precision is expressed as the number of decimal digits of precision allowed for the fractional second portion of the time value. The default is 0, which means fractional seconds are not returned in the time value. The range for this setting is 0–9 digits of precision. The actual time precision is platform dependent. You can also set this option using the $SYSTEM.SQL.SetDefaultTimePrecision() method.
For further details, refer to the SET OPTION command.
Identifier Translation - From:
String of characters that provides the “From” list for DDL Identifier Translation mappings. The maximum length of the string is 256 characters. The default string is:
~ `!@#$%^&*()_+-=[]\{}|;':",./<>?
These mappings filter/modify valid SQL identifier characters when translating SQL identifiers into Objects identifiers. When converting an SQL identifier to an Objects identifier at DDL runtime, the characters in the “From” string are converted to the characters in the “To” string. See Identifier Translation – To. For further details, see the “Identifiers” chapter of Using Caché SQL.
The “To” string of characters provides the “To” list for DDL Identifier Translation mappings. The maximum length of the string is 256 characters. The default is an empty string. You can also set this option using the $SYSTEM.SQL.SetDDLIdentifierTranslations() method.
Identifier Translation - To:
String of characters that provides the “To” list for DDL Identifier Translation mappings. The maximum length of the string is 256 characters. The default is an empty string. See Identifier Translation – From. For further details, see the “Identifiers” chapter of Using Caché SQL. You can also set this option using the $SYSTEM.SQL.SetDDLIdentifierTranslations() method.
Lock Threshold:
The number of SQL inserts, updates, or deletes for a single table within a single transaction that will trigger a table-level lock when reached. For example, if the lock threshold is 1000 and a process starts a transaction and then inserts 2000 rows, when the 1001st row is inserted the process will attempt to acquire a table-level lock instead of continue to lock individual rows. This is to help keep the lock table from becoming too full. The SQL lock threshold may be any integer. The default is 1000. You can also set this option using the $SYSTEM.SQL.SetLockThreshold() method.
When you change and save this setting, new processes that start have the new setting.
For further details, refer to the DELETE, INSERT, TRUNCATE TABLE, and UPDATE commands.
Lock Timeout (in seconds):
Lock timeout for Caché locks made during execution of SQL statements. The default is 10 seconds. The range is 0–32767 seconds (up to 9 hours). Changing this option affects only new processes; existing processes are not affected. You can also set this option using the $SYSTEM.SQL.SetLockTimeout() method.
For further details, refer to the SET OPTION command.
Perform Referential Integrity Checks on Foreign Keys for INSERT, UPDATE, and DELETE:
Yes or No. When Yes, the system validates the foreign key constraint for INSERT, UPDATE, DELETE, and TRUNCATE TABLE operations. When No, Caché bypasses validation of foreign key constraints. The default is Yes. Changing this option affects only new processes; existing processes are not affected. You can also set this option using the $SYSTEM.SQL.SetFilerRefIntegrity() method.
For further details, refer to the DELETE, INSERT, TRUNCATE TABLE, and UPDATE commands.
Retains SQL Statement as Comments in .INT Code:
Yes or No. When Yes, embedded SQL statements are retained as comments in the .INT code version of the routine. The default is Yes. You can also set this option using the $SYSTEM.SQL.SetRetainSQL() method.
SQL Security Enabled:
Yes or No. When Yes, all Caché SQL security is enabled. This means privilege-based table/view/procedure security is active. A user can only perform actions on a table or view for which that user has been granted privilege. When No, SQL Security is disabled. This means privilege-based table/view/procedure security is suppressed. A user can perform actions on a table or view even if that user has no privileges to do so. The default is Yes. Changing this option affects only new processes; existing processes are not affected. You can also set this option using the $SYSTEM.SQL.SetSQLSecurity() method.
For further details, refer to the GRANT, CREATE TABLE, and CREATE VIEW commands.
SQL SELECT Synchronizes ECP Cache:
Yes or No. When Yes, Caché implementations that use Enterprise Cache Protocol (ECP) synchronize query results. ECP is a distributed data caching architecture that manages the distribution of data and locks among a heterogeneous network of server systems. When Yes, each time a SELECT statement is executed Caché forces all pending ECP requests to the database server. On completion this guarantees that the client cache is in sync. The default is No. You can also set this option using the $SYSTEM.SQL.SetECPSync() method.
For further details, refer to Queries and ECP in the “Querying the Database” chapter of Using Caché SQL.
Support Delimited Identifiers:
Yes or No. When Yes, a double-quoted string ("My String") is considered a delimited identifier within an SQL statement. When No, a double-quoted string ("My String") is considered a string constant or literal string. The default is Yes. Changing this option causes the purging of all cached queries in all namespaces. You can also set this option using the $SYSTEM.SQL.SetDelimitedIdentifiers() method.
For further details, refer to the SET OPTION command. For further details on delimited identifiers, see the “Identifiers” chapter of Using Caché SQL.
TCP Keep Alive interval (in seconds):
An integer that specifies the number of seconds to keep alive the TCP connection. Valid values range from 1 to 432000 (432000 seconds is 5 days). The default is 300. You can also set this option using the $SYSTEM.SQL.SetTCPKeepAlive() method.
For further details, refer to the TCP Client/Server Communication chapter of the Caché I/O Device Guide.
DDL Tab
Allow Create Primary Key Through DDL When Key Exists:
Yes or No. When Yes, you can create a primary key constraint to a table through DDL even when a primary key constraint already exists for that table. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo307() method.
For further details, refer to the CREATE TABLE and ALTER TABLE commands.
Allow DDL ADD Foreign Key Constraint when Foreign Key Exists:
Yes or No. When Yes, you can add a foreign key through DDL even if one with the same name already exists. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo311() method.
For further details, refer to the ALTER TABLE command.
Allow DDL CREATE INDEX for Existing Index:
Yes or No. When Yes, you can create an index through DDL even if one with the same name already exists. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo324() method.
For further details, refer to the CREATE INDEX command.
Allow DDL CREATE TABLE or CREATE VIEW for Existing Table:
Yes or No. When Yes, you can create a table or view through DDL even if one with the same name already exists. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo201() method.
For further details, refer to the CREATE TABLE and CREATE VIEW commands.
Allow DDL DROP of Non-existent Index:
Yes or No. When Yes, you can drop an index through DDL even if an index of that name does not exist. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo333() method.
For further details, refer to the DROP INDEX command.
Allow DDL DROP of Non-existent Table or View:
Yes or No. When Yes, you can drop (delete) a table definition through DDL even if an index of that name does not exist. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo30() method.
For further details, refer to the DROP TABLE and DROP VIEW commands.
Allow DDL DROP of Nonconstraint:
Yes or No. When Yes, you can drop a field constraint through DDL even if a constraint of that name does not exist. When No, this action triggers an error code if attempted. The default is No. You can also set this option using the $SYSTEM.SQL.SetDDLNo315() method.
For further details, refer to the ALTER TABLE command.
Are Primary Keys Created through DDL not ID Keys?:
Yes or No. When Yes, when a Primary Key constraint is specified through DDL it does not also become the IDKey index in the class definition. If No, a Primary Key constraint specified through DDL also becomes the IDKey index in the class definition. The No option generally gives better performance, but means that the Primary Key fields cannot be updated. The default is Yes. You can also set this option using the $SYSTEM.SQL.SetDDLPKeyNotIDKey() method.
For further details, refer to the SET OPTION, CREATE TABLE, and ALTER TABLE commands.
Does DDL DROP TABLE Delete the Table's Data?:
Yes or No. When Yes, a DDL DROP TABLE statement deletes the table’s data. When No, it deletes the table, but does not delete the data. The default is Yes. You can also set this option using the $SYSTEM.SQL.SetDDLDropTabDelData() method.
For further details, refer to the DROP TABLE command.
Optimization Tab
The optimization hint (%) options provide the specified optimization behavior for all queries system-wide, regardless of the presence of these optimization hint keywords in the individual queries. Corresponding keywords in individual queries are permitted but not required. You can also set these system-wide options using SET ^%SYS("HINT","keyword")=val. For example, SET ^%SYS("HINT","%NOUNIONOROPT")=1. A system-wide hint set in this way is reflected in the Management Portal checkboxes (you may need to refresh the Management Portal display by pressing the F5 key.)
DISTINCT optimization turned ON:
Yes or No. When Yes, SQL queries involving DISTINCT or GROUP BY clauses run more efficiently by making better use of indices (if indices are available). However, the values returned by such optimized queries are collated in the same way that they are stored within the index. This means that the results of such queries may be all uppercase. This may have an effect on case-sensitive applications. The default is Yes. You can also set this option using the SetFastDistinct() method.
For further details, refer to the GROUP BY clause and the DISTINCT clause of the SELECT statement.
BIAS_QUERIES_AS_OUTLIER:
Yes or No. When No, the query optimizer assumes that queries do not normally use WHERE conditions on a non-null outlier value; therefore, some queries that do use WHERE conditions on the non-null outlier value will not perform as well. When Yes, the query optimizer assumes that queries using WHERE conditions on a non-null outlier are common; therefore, some queries that use WHERE conditions on other values will not perform as well. For further details on outlier selectivity, refer to Tune Table in the “Optimizing Tables” chapter of the Caché SQL Optimization Guide.
%ALLINDEX:
Yes or No. When Yes, all SQL queries system-wide use all indexes that provide any benefit for the first table in the query join order. When No, the optimizer uses only those indexes that the optimizer judges to be most beneficial. The default is No. You can specify exceptions to %ALLINDEX in specific queries for specific conditions with the %NOINDEX condition-level hint. For further details, refer to the FROM clause of the SELECT statement.
%NOFLATTEN:
Yes or No. When Yes, all SQL queries system-wide inhibit subquery flattening. The default is No. For further details, refer to the FROM clause of the SELECT statement.
%NOMERGE:
Yes or No. When Yes, all SQL queries system-wide inhibit the conversion of a subquery to a view. The default is No. For further details, refer to the FROM clause of the SELECT statement.
%NOSVSO:
Yes or No. When Yes, all SQL queries system-wide inhibit Set-Valued Subquery Optimization (SVSO). The default is No. For further details, refer to the FROM clause of the SELECT statement.
%NOTOPOPT:
Yes or No. When Yes, all SQL queries system-wide disable the automatic TOP with ORDER BY optimizations. The default is No. For further details, refer to the FROM clause of the SELECT statement.
%NOUNIONOROPT:
Yes or No. When Yes, all SQL queries system-wide disable the automatic optimizations provided for multiple OR conditions and for subqueries against a UNION query expression. The default is No. For further details, refer to the FROM clause of the SELECT statement.
TSQL Compatibility Settings
The TSQL Compatibility Settings page (System Administration > Configuration > SQL and Object Settings > TSQL Compatibility Settings) contains the following settings:
DIALECT:
The DIALECT configuration option allows you to select the Transact-SQL dialect. The available options are Sybase and MSSQL. The default is Sybase.
ANSI-NULLS:
Specifies whether comparisons to a null value return true or false.
ON = All comparisons to a null value evaluate to Unknown.
For example: Age = Null returns false. Null is unknown, so it is false/unknown if Age = Unknown.
OFF = Comparisons of non-Unicode values to a null value evaluate to True if both values are null.
For example: Age = Null returns true for null values for Age.
CASSEINSCOMPARE:
The CASEINSCOMPARE setting specifies non-case-sensitive equality comparisons, such as 'A'='a'. If this flag is set, the comparison operators = and <> operate without regard to case in most contexts. However, there are a few contexts where such insensitivity does not apply:
These exceptions exist because Caché SQL does not accept the %SQLUPPER operator in these contexts.
You can activate (=1) or deactivate (=0) CASEINSCOMPARE system-wide using the following ObjectScript command:
  SET ^%sys("tsql","CASEINSCOMPARE")=1
QUOTED_IDENTIFIER:
The QUOTED_IDENTIFIER configuration option allows you to select whether quoted identifiers are supported. The default is OFF (not supported).
ISQL Compatibility Settings
The ISQL Compatibility Settings page (System Administration > Configuration > SQL and Object Settings > ISQL Compatibility Settings) contains the following settings:
Support Delimited Identifiers:
Yes - All ISQL identifiers are created as ordinary identifiers.
No - All ISQL identifiers are created as delimited identifiers.
Generate Trace Code:
Yes - Trace code is generated during a session.
No - Trace code is not generated during a session.
Return Result of Stored Procedure Call as Resultset:
Yes - Return result of a stored procedure call as a resultset.
No -
Reserved Word Prefix:
Specify a prefix to be appended to a column name when that column name conflicts with an SQL reserved word.
FileMan Conversion Settings
The FileMan Conversion Settings page (System Administration > Configuration > SQL and Object Settings > FileMan Conversion Settings) contains the following settings. These settings define how FileMan data structures are converted to InterSystems class definitions.
Owner of the Classes Created:
For each class, the class keyword Owner is created with the value specified in the settings. The default is the current value in $Username. The owner of the classes is granted all SQL privileges on all SQL objects projected by the class (tables, views, stored procedures). The owner can insert, update, delete, and execute statements against the projected tables, views, and procedures.
Package Name to Create the Classes in:
Package name to create the classes in.
Note:
If you previously mapped to one package and map the FileMan files again to a new package, the old classes are not automatically deleted.
SuperClasses:
A string of comma-delimited classes to which each mapped class should extend.
Table Name Format Based on the File Name and Number:
Specifies the format of the generated table name. For this setting, specify a string that uses the following keywords along with any characters that are valid to use as table names:
If you use <FILENAME>, any decimal place characters in the file number are converted to underscore characters.
See the examples for Child Table Name Format Based on the File Name and Number.
Child Table Name Format Based on the File Name and Number:
Specifies the format of the generated child table names. For this setting, specify a string that uses the following keywords along with any characters that are valid to use as table names:
If you use <FILENAME> or <PARFILENUMBER>, any decimal place characters in the file number are converted to underscore characters.
Some examples of this setting:
Datatype to use for FileMan Date fields:
Specifies the data type to use when mapping FileMan DATE fields. The default is %Library.FilemanDate.
Datatype to use for FileMan DateTime fields:
Specifies the data type to use when mapping FileMan DATE/TIME fields. The default is %Library.FilemanTimeStamp.
Expand Pointers?
Specifies whether the utility creates additional computed properties to expand the pointer field.
If it does so, the utility creates a computed property that expands the pointer field and is equal to the NAME (.01) field in the referenced file.
Extended Mapping:
Specifies a string to be inserted into the global name in the map definitions for extended mapping purposes. For example, you might specify ["SD"] and your global will be mapped as ^["SD"]LR(...) instead of ^LR(...).
This can be any valid string that can be used for extended global mapping and should include the [...] or |...| brackets.
Name of the IEN Field:
Specifies the name of the IEN field, which is IEN by default.
Retain Class?
Specifies whether to recreate the entire class if it already exists.
Recursion:
Controls whether sub-files and pointer are also mapped:
Word-Processing Fields Conversion:
Specifies how to map word-processing fields. Select either Convert as child tables or Convert as list collections.
Read Only?Log File:
Specifies whether the generated classes should be read-only.
Compile Classes:
Specifies whether to compile the classes after creating them.
Compile flags:
Specifies any class compiler qualifiers and/or flags. The default is /display=all/lock=0
Delete Flags:
Specifies any class deletion qualifiers and/or flags. Default is /display=all
Display Result:
Controls how the results are displayed, No screen display, Minimal screen display, Full screen display.
System-Defined DDL Mappings
The System-Defined DDL Mappings page (System Administration > Configuration > SQL and Object Settings > System-Defined DDL Mappings) contains the following settings:
System-Defined DDL Mappings
Collection of system-defined datatype descriptions. Each description maps an SQL datatype to its Caché equivalent. See UserDataTypes.
—Configuration Fields—
Key-the name of the SQL datatype plus any allowed arguments.
Value-the Caché equivalent, including any constraints on the arguments
User-Defined DDL Mappings
The User-Defined DDL Mappings page (System Administration > Configuration > SQL and Object Settings > User-Defined DDL Mappings) contains the following settings:
User-Defined DDL Mappings
Collection of user-defined datatype descriptions. Each description maps an SQL datatype to its Caché equivalent. See SystemDataTypes.
—Configuration Fields—
Key-the name of the SQL datatype plus any allowed arguments.
Value-the Caché equivalent, including any constraints on the arguments
Startup Settings
The Startup Settings page (System Administration > Configuration > Additional Settings > Startup) contains the following settings:
CallinHalt
True or false. When true, Caché executes the CALLIN^%ZSTOP routine entry each time an external program ends a CALLIN. The default is true.
CallinStart
True or false. When true, Caché executes the CALLIN^%ZSTART routine entry each time an external program initiates a CALLIN. The default is true.
CliSysName
Node name for the local system. The value n has many uses:
The default is blank. If no name is provided, Caché reads the computer settings and uses the computer “host name” as the client node name. This can be up to 64 characters long.
DBSizesAllowed
Comma-separated list of database block sizes (in multiples of 1024) allowed to be entered in the database creation screen. Default is 8192 (you cannot clear this checkbox). Example: 8192,16384. Note that after you select database block sizes, you must also configure the memory allocated to each block size, as described in Memory and Startup Settings in the “Configuring Caché” chapter of the Caché System Administration Guide, in order to create global buffers for the selected block sizes and enable database creation. See Large Block Size Considerations in the “Configuring Caché” chapter of the Caché System Administration Guide for guidelines for choosing the appropriate database block/global buffer sizes for your applications.
DefaultPortBindAddress
Specify an IP address for the SuperServer to bind to.
Set to one of the host system's IP addresses. The SuperServer binds to that address. Requests to the SuperServer port on other IP addresses on the host are not accepted. This makes it possible to limit connections to the SuperServer to a single address on a multihomed host. The SuperServer is the process that accepts client connections for Cache Direct, ODBC, JDBC, Cache Studio, and other connection technologies. If this property is not set, the SuperServer accepts requests on all IP addresses on the host. The default is to accept on all addresses.
EnsembleAutoStart
Ensemble only.
True or false. When true, the production you set to auto-start in each Ensemble namespace starts when you start Ensemble. To facilitate debugging situations involving troubled productions, you can disable this setting to prevent a production from starting. This entry is ignored if this is not an Ensemble system. The default is true.
See the description of the Auto-Start Production field in the chapter Starting and Stopping Productions of Managing Ensemble Productions for details on how this setting works with Ensemble production settings.
ErrorPurge
Number of days before the error globals for the ^%ET error handler are marked for purge. The purge occurs at the next Caché startup. The default is 30 days. The range is 1–1000 days.
If you edit this setting, the change is applied the next time you restart Caché.
FIPSMode
True or false. When true, Caché uses the FIPS 140–2 compliant library for database encryption on Red Hat Enterprise Linux 6.6 (or later minor version) and Red Hat Enterprise Linux 7.1 (or later minor version) for x86-64. The default is false. See the article FIPS 140–2 Compliance for Caché Database Encryption for details.
IPv6
True or false. When true, this indicates that your system is operating in an IPv6 (Internet Protocol Version 6) network with IPv6 addresses. The default is false.
JobHalt
True or false. When true, Caché executes the JOB^%ZSTOP routine entry each time a background process ends. The default is true. Background processes include any processes that are started via the JOB command, plus any background server processes including CSP, Caché Direct, ODBC, or any of the objects bindings.
JobServers
Number of job servers you want Caché to start up. The default is 0. The range is 0–2000.
Having a large number of job servers running will use more memory and processes, but allows for much faster jobbing of processes because Caché doesn't have to start the processes at the system level and then initialize them.
Job servers are best used when the application creates a significant number of short-lived processes via the Job command. For this type of process where operating system process creation overhead dominates the total cost of running the process, using job servers can be beneficial. If background processes tend to perform extended tasks then there is very little benefit from using job servers.
If you edit this setting, you must restart Caché to apply the change.
JobStart
True or false. When true, Caché executes the JOB^%ZSTART routine entry each time a background process starts up. The default is true. Background processes include any processes that are started via the JOB command, plus any background server processes including CSP, Caché Direct, ODBC, or any of the objects bindings.
MaxCacheTempSizeAtStart
Maximium size in megabytes of the CacheTemp database when the system is restarted. When the system restarts, the CacheTemp database is truncated to this size. If 0, the CacheTemp database is not truncated. The range is 0-1000000.
MaxConsoleLogSize
Maximum size of the Caché console file, in megabytes. The console file is either the cconsole.log in the Caché system management directory, or the filename.log named by the ConsoleFile setting.
If you enter a value (in MB) that is smaller than the current setting of MaxConsoleLogSize, then the current console log file, filename.log, is immediately renamed to filename.old_Date. The system creates a new filename.log file. New entries are appended to the newly-created file.
If the console file grows larger than the size set with MaxConsoleLogSize, the task manager Purge errors and log files task performs the rename and the filename.log creation the next time it runs.
The default ConsoleLogSize is 5 megabytes. The range is 1–500 megabytes.
ProcessHalt
True or false. When true, Caché executes the LOGIN^%ZSTOP routine entry each time a terminal user logs out. The default is true.
ProcessStart
True or false. When true, Caché executes the LOGIN^%ZSTART routine entry each time a terminal user logs in. The default is true.
ShutdownTimeout
Number of seconds Caché should wait for shutdown to complete normally before timing out and forcing a shutdown. The default is 300 seconds (5 minutes). The range is 120 to a maximum of 100,000 seconds.
If you edit this setting, the change applies automatically the next time you restart Caché.
SystemHalt
True or false. When true, Caché executes the SYSTEM^%ZSTOP routine entry each time it shuts down. The default is true.
SystemStart
True or false. When true, Caché executes the SYSTEM^%ZSTART routine entry each time it starts up. The default is true.
If you edit this setting, the change applies automatically the next time you restart Caché.
TempDirectory
Name of a subdirectory in which to store temporary files for Caché. The string is assumed to be a relative pathname, the name of a subdirectory under the Mgr subdirectory in the Caché installation directory. The default value for TempDirectory is:
Temp
Which identifies the following location under install-dir, the Caché installation directory:
install-dir\Mgr\Temp
When you set a new TempDirectory value, the system creates a subdirectory of this name under the Mgr subdirectory in the Caché installation directory, as shown for Temp in the previous example. This new directory becomes the Caché temporary directory.
TerminalPrompt
A comma separated string of values (0–8) which set the default terminal prompt for the system. The default is 8,2
The order of the values in the string is the order the values appear in the prompt. For example
TerminalPrompt="2,1" 
gives you a terminal prompt of %SYS:HostName>
WebServer
Start the private Webserver when Caché starts. For information on the private Webserver, see the section Minimal Apache Web Server or Private Web Server in the CSP Gateway Configuration Guide.
WebServerName
The DNS name or IP address of the Web Server that is configured for use with Caché tools. For example if Studio is connected to this Caché system, and if the user requests to run a CSP template from Studio, WebServerName identifies the DNS name or IP address to which this request will be sent. See WebServerPort.
If you edit this setting, you must restart Caché to apply the change.
WebServerPort
Web Server port number. Setting this number to any non-zero value enables the Web Server on that port. If you set this number to 0, the Web Server is disabled. A standard Caché installation sets the Web server port number to the first unused port number greater than or equal to 57772. On non-OpenVMS systems, the Web server runs on the same system as the Caché server. On OpenVMS systems, a WebServerName is required.
If you edit this setting, you must restart Caché to apply the change.
WebServerURLPrefix
The Caché instance name. This is the name you assigned to Caché when you installed it. You must provide the WebServerURLPrefix value for each Caché instance if you are using a remote Web server to access one or more Caché instances.
This is only one of the steps required to set up a remote Web server to access one or more Caché instances. For details, see the Connecting to Remote Servers chapter in the Caché System Administration Guide.
ZSTU
True or false. When true, Caché runs the user-defined startup from the ^ZSTU routine. The default is true.
If you edit this setting, the change applies automatically the next time you restart Caché.
Task Manager Email Settings
The Task Manager Email Settings page (System Administration > Configuration > Additional Settings > Task Manager Email) contains the following settings. For more information, see Configuring Task Manager Email Settings in the Caché System Administration Guide.
SMTP Server and Port
Address and port of your outgoing SMTP (Simple Mail Transfer Protocol) mail server
SSL Config
The SSL configuration to use if you want to encrypt the email using SSL/TLS. If there are no SSL configurations on the instance, or you want to create a new one, see Creating or Editing an SSL/TLS Configuration in the “Using SSL/TLS with Caché” chapter of the Caché Security Administration Guide. If you do not select an SSL configuration, SSL/TLS will not be used.
SMTP Auth User and Password
Required only for SMTP authentication to the SMTP server. See RFC 2554 for details. If you do not provide entries, SMTP username and password are set to NULL.
Sender
Required only for SMTP authentication to the SMTP server. See RFC 2554 for details.
Reply To
Email address to which the recipient should reply
Success Subject
The formatted subject line of a successful task message. See the section “Parameters for Subjects and Messages” below.
Success Message
The formatted message sent after a successful task runs
Failure Subject
The formatted subject line of a failed task message
Failure Message
The formatted message sent after a task fails
Parameters for Subjects and Messages
Format the information in the subject and message text boxes using the task parameters listed at the bottom of the web page and defined in the following table. The web page includes examples.
Task Parameter Description
ID Task ID
DESCRIPTION Task description
NAME Task name
LASTSTARTED Last time the task started
LASTFINISHED Last time the task finished
SCHEDULED Last scheduled starting time
CURRENTDATE Date the email sent
CURRENTTIME Time the email sent
STATUS Return value of the task
TASKCLASS Task class used for this task; for example, %SYS.Task.IntegrityCheck for a database integrity check task,
ERROR Error code if task failed
SUCCESS Completed message if task ran successfully
Zen Reports
The following settings are on the System Administration > Configuration > Zen Reports menu:
Zen Report Render Servers
The Zen Reports Render Servers page (System Administration > Configuration > Zen Reports > Render Servers) contains the following settings:
New Zen Report Server
Enter the full path to the fop or the xep executable file and select Save. For windows, fop.bat orxep.bat; for UNIX®, fop.sh or xep.sh; for OpenVMS, fop.com or the xep.com. For more information, see the section Configuring Zen for PDF Output in the book Using Zen Reports.
If you configure a Render Server to use RenderX XEP, two additional fields appear on the configuration page:
RenderX can consume memory as it runs, so a cleaning operation needs to be performed periodically. Cleaning also consumes resources, so these two fields are provided to let you set the parameters that determine when cleaning takes place. The need for cleaning is determined by the number of files RenderX has processed. Use the field Num. Files Before Clean (XEP) to set this number. The value set in How Often To Clean (XEP) determines how often the Render Server checks whether RenderX has reached the file limit.
Once you have saved your changes, use the Cancel button to return to the [Home] > [Configuration] > [Zen Report Render Servers] page, where you see that the new Render Server has been added to the list.
Zen Report Settings
The Zen Report Settings page (System Administration > Configuration > Zen Reports > Settings) contains the following settings:
Path and file name to be used for PDF generation:
Enter the full path to the fop or the xep executable file and select Save. For windows, fop.bat or xep.bat; for UNIX®, fop.sh or xep.sh; for OpenVMS, fop.com or the xep.com. For more information, see the section Configuring Zen for PDF Output in the book Using Zen Reports.
Configuration file:
Enter the full path name of a configuration file to use for Zen Reports and select Save. If this field is empty and Zen Reports does not set USEINSTALLEDFOP=0, the file fop.xconf is used.
Adobe Path for pdfprint:
Enter or select the full path to the Adobe Reader and select Save.
Java_Home environment variable:
The Java home environment variable is displayed here if one is set.
To verify that the xsl engine is configured correctly, select here: Verify Now
Select Verify Now to ensure that you have installed either the fop or xep programs and that the accurate full path to the executable file (appropriate to your operating system) is named and (was saved) in the file name field below. For more information, see the section Configuring Zen for PDF Output in the book Using Zen Reports.