Configuring Caché

Caché System Administration Guide

Configuring Caché

Server:docs.intersystems.com

Instance:CACHE20102

User:UnknownUser


	[Documentation] > [System Administration] > [System Administration Guide] > [Configuring Caché]		Go to:		Search:

A Caché configuration is composed of system configuration information, namespaces, databases, operator task configurations, network connections, and other advanced settings.

Use the System Management Portal to set up a Caché system and view its configuration parameters. You can use the portal to adjust system settings as well as to create and modify namespaces, databases, and network connections, and to connect to the CSP Gateway to configure CSP applications.

The major configuration tasks are subdivided into the following categories: System Configuration, Connectivity and Additional Settings. These, in turn, are divided into subcategories. This chapter describes some of the topics; other topics have separate chapters or documents as references. See the listed document sources in the following tables for detailed information.

Configure settings for this system from the System Configuration menu.

System Configuration Tasks

Menu Item	Documentation Source
Memory and Startup	Configuring System Information section of this chapter
Namespaces	Configuring Namespaces section of this chapter
Local Databases	Configuring Local Databases section of this chapter
Remote Databases	Configuring Remote Databases section of this chapter
Database Backup Settings	Configuring Caché Backup Settings section of the “Backup and Restore” chapter of the Caché Data Integrity Guide
Journal Settings	Configuring Journal File Settings section of the “Journaling” chapter of the Caché Data Integrity Guide

Configure network connections with other systems from the Connectivity menu.

Connectivity Tasks

Menu Item	Documentation Source
ECP Settings	“Configuring Distributed Systems” chapter of the Caché Distributed Data Management Guide
Mirror Settings	Configuring Mirroring section of the “Mirroring” chapter of the Caché High Availability Guide
Shadow Server Settings	Configuring Shadowing section of the “Shadowing” chapter of the Caché Data Integrity Guide
Object/SQL Gateway Settings	“Using the Caché SQL Gateway” chapter of Using Caché SQL. For detailed information on creating logical connection definitions for JDBC, ODBC and .NET, see: Using the Caché SQL Gateway with JDBC in Using Caché with JDBC Using the Caché SQL Gateway with ODBC in Using Caché with ODBC Using the Object Gateway for .NET
CSP Gateway Management	“CSP Configuration” chapter of Using Caché Server Pages
Cluster Settings	Cluster Settings section of this chapter

Configure additional settings from the Additional Settings menu. For a summary of additional configuration settings, see the Caché Additional Configuration Settings Reference.

Additional Tasks

Menu Item	Documentation Source
Compatibility Settings	Miscellaneous Settings of Caché Additional Configuration Settings Reference
Device Settings	Device Settings of Caché Additional Configuration Settings Reference
Advanced Memory Settings	Advanced Memory Settings of Caché Additional Configuration Settings Reference
Monitor Settings	“Monitoring Caché Using BMC PATROL”, “Monitoring Caché Using SNMP”, and “Monitoring Caché Using WMI” appendixes of the Caché Monitoring Guide
NLS Settings	Configuring NLS Settings section of this chapter
Source Control Settings	“Using Studio Source Control Hooks” appendix of Using Caché Studio
SQL Settings	Configuration Settings section of the Caché SQL Reference
Startup Settings	Startup Settings of Caché Additional Configuration Settings Reference
Task Manager Email Settings	Configuring Task Manager Email Settings section of this chapter
Zen Report Settings	Configuring Zen Report Settings section of this chapter

Most configuration changes can be done dynamically and do not require you to restart Caché. When the update does require a restart, the portal notifies you.

This chapter covers the following topics:

Configuring Data

Caché stores data — persistent multidimensional arrays (globals) as well as executable code (routines) — in one or more physical structures called databases. A database consists of one or more physical files stored in the local operating system. A Caché system may (and usually does) have multiple databases.

Each Caché system maintains a database cache — a local, shared memory buffer used to cache data retrieved from the physical databases. This cache greatly reduces the amount of costly I/O operations required to access data and provides much of the performance benefits of Caché.

Caché applications access data by means of a namespace. A namespace provides a logical view of data (globals and routines) stored in one or more physical databases. A Caché system may (and usually does) have multiple namespaces. Caché maps the data visible in a logical namespace to one or more physical databases. This mapping provides applications with a powerful mechanism for changing an application’s physical deployment without changing application logic.

In the simplest case, there is a one-to-one correspondence between a namespace and a database, but many systems take advantage of the ability to define a namespace that provides access to data in multiple databases. For example, a system could have multiple namespaces, each of which provides a different logical view of the data stored within one or more physical databases.

For more details, see the following sections:

See the Config entries in the Caché Class Reference for information about updating namespaces, databases, and mappings programmatically.

Configuring Namespaces

A namespace is a collection of data and programs in a virtual work space. In a namespace, you can define the globals that various groups or people need. For example, if your accounting department needs to use certain globals that exist on different systems or in different directories, you can set up a single namespace that references all the accounting globals and databases on your network.

Caché comes with the following predefined namespaces:

%SYS — System management information and utilities.
DOCBOOK — Documentation.
SAMPLES — Sample code and applications.
USER — Empty at installation. Typically used for application development.

Perform the following procedures for configuring namespaces from the [Home] > [Configuration] > [Namespaces] page of the System Management Portal:

The size of the namespace table is automatic and no longer configurable.

Create a Namespace

You can create a new namespace at any time, but when you are first setting up the system, create the basic ones that your users need. To create a namespace, click Create New Namespace on the [Home] > [Configuration] > [Namespaces] page, then do the following:

Enter a Name for the namespace.

Namespace names must be at least one character (but not more than 255 characters) long, starting with an alphabetic character or a percent sign (%) followed by an arbitrary number of alphanumeric characters, dashes, or underscores.

Important:
Do not specify the following reserved system names: BIN, BROKER, DOCBOOK, DOCUMATIC, SYS.
Choose whether the default database is local or remote.
Select an existing database for the default mapping of this namespace, or click Create New Database
Select the Create a default CSP application for this namespace check box if you are creating a CSP application that accesses this namespace.
You can also Copy namespace mappings from an existing namespace.
After entering the required information, click Save to add your namespace to the configuration.

Modify Default Database Mapping

You can change the database to which your namespace is mapped without restarting Caché:

Navigate to the [Home] > [Configuration] > [Namespaces] page to see a list of defined namespaces.
Click Edit in the row of the namespace you wish to modify.
Choose the Default Database for Globals, the Default Database for Routines, and the Default Database for Temporary Storage from the list of defined databases.
Click Save.

Note:

Users directly accessing the database at the time of the change may need to log off and then log on to Caché to update their namespace mapping.

Add Global, Routine, and Package Mapping to a Namespace

In addition to having access to the globals and routines in the mapped database, you can also map globals, routines, and class packages from other databases on the same or different systems. This allows simple references to data which can exist anywhere and is the primary feature of a namespace. You can map whole globals or pieces of globals; this feature allows data to easily span disks.

Note:

Mappings are sorted alphabetically; if subscripts are specified, they are sorted by name and subscript. See the “Global Structure” chapter of the Using Caché Globals guide).

Click the appropriate choice to begin mapping:

The following is a schematic diagram of how mapping works in a sample airline reservation application:

Sample Namespace Mapping

Data and programs are stored in Caché databases, the physical storage locations, and referred to by namespaces, the logical references.

Global Mappings

You can add mapping to your namespace at the global and global subscript level that overrides the default database mapping for globals of the namespace:

Navigate to the [Home] > [Configuration] > [Namespaces] page, and click Global Mappings in the row of the namespace where you want to map the global.
From the [Global Mappings] page click New Global Mapping.
Select the Global database location database where the global is located.
Enter the Global name. You can use the * character to choose multiple globals.
Enter the Global subscripts to be mapped. The subscript reference must begin with an open parenthesis. Some examples follow:
```
(1)
("A")
(1):(5)
("A"):("Z")
(BEGIN):("X")
("Y"):(END)
```
Note:
When specifying a range (for example, ("A"):("Z"), the range is “from-to” (not “from-through”) the specified subscripts; that is, the lower end of a defined subscript range is inclusive, while the upper end of the defined subscript range is exclusive. For example, Name (1):(10) includes Name (1) but does not include Name (10); the exclusive upper range allows you to have a defined upper boundary when working with subscripted ranges, such as Name ("a"):("b"), where Name ("aa") and Name ("aaaaa") are equally valid ranges to precede Name ("b").

You can use the reserved words BEGIN and END to refer to the first and last possible subscripts; however, you cannot use the asterisk (*) wildcard with subscripted globals because global subscripts must be mapped individually.

For more information about subscript-level mapping (SLM) ranges, see Setting Global Mappings in the “Global Structure” chapter of Using Caché Globals.
Click Advanced to display the following:
1. Select the Collation.
2. Select the Lock Database Location.
Click OK.

Note:
>> displayed in the first column of the new mappings row indicates that you opened the mapping for editing.
To save the mappings in the cpf file, click Save Changes.

Routine Mappings

You can add mappings to your namespace at the routine level that overrides the default database mapping for routines of the namespace:

Navigate to the [Home] > [Configuration] > [Namespaces] page, and click Routine Mappings in the row of the namespace where you want to map the global.
From the [Home] > [Configuration] > [Namespaces] > [Routine Mappings] page, click New Routine Mapping.
Select the Routine database location database where the routine is located.
Enter the Routine name. The routine does not have to exist when you map it (that is, it can be the name of a routine you plan to create).
Select the Routine type.
Click OK.

Note:
>> displayed in the first column of the new mappings row indicates that you opened the mapping for editing.
To save the mappings in the cpf file, click Save Changes.

For example, using the preceding Sample Namespace Mapping example, if you plan to create a schedule routine (for example, BOSZZairline) in the airports database (in the FlightSchedule namespace) and you want it to be available to users in the TravelAgent namespace, you would navigate to the [Home] > [Configuration] > [Namespaces] > [Routine Mappings] page (in the TravelAgent namespace row), then click New Routine Mapping. Enter the information as shown in the following Routine Mapping dialog box:

Important:

If the routines in one namespace (say, N1) are mapped to refer to another database (say D2), then the ^mcq and ^mqh globals in the namespace being mapped (N1) also need to be mapped to that other database (D2) as well.

Package Mappings

You can add a class package mappings which makes all the classes within a package in a specific database visible to another namespace:

Navigate to the [Home] > [Configuration] > [Namespaces] page, and click Package Mappings in the row of the namespace where you want to map the package.
From the [Home] > [Configuration] > [Namespaces] > [Package Mappings] page, click New Package Mapping.
Select the Package database location database where the package is located.
Select the Package name. The package does not have to exist when you map it (that is, it can be the name of a package you plan to create); you can specify a new package name, as follows:
1. Click New Package.
2. In the New package name text box, enter a name.
Click OK.

Note:
>> displayed in the first column of the new mappings row indicates that you opened the mapping for editing.
To save the mappings in the cpf file, click Save Changes.

See the Package Mapping section in the “Packages” chapter of Using Caché Objects for a description of packages and the procedure for mapping them.

For example, to make the class definitions in the Cinema package of the SAMPLES database available in the TESTSAMPLES namespace, navigate to the [Home] > [Configuration] > [Namespaces] > [Package Mappings] page and click New Package Mapping. Enter the information as shown in the following Package Mapping dialog box:

Mapping Data to All Namespaces

In addition to mapping globals, routines, and packages to specific namespaces, you can map them to all namespaces (except DOCBOOK and SAMPLES). To enable this form of mapping, you must first create a namespace named %ALL (see the Create a Namespace section of this guide). Then, use the procedures described in the Add Global, Routine, and Package Mapping to a Namespace section of this guide, choosing Global Mappings, Routine Mappings or Package Mappings in the %ALL namespace row.

Note:

%ALL is not visible except for the purposes of mapping data; that is, it is not a real namespace, but a mechanism for mapping data to all namespaces (except DOCBOOK and SAMPLES).

To map data specifically to the DOCBOOK and SAMPLES namespaces, use the procedures in the Add Global, Routine, and Package Mapping to a Namespace section of this guide, choosing Global Mappings, Routine Mappings or Package Mappings in the DOCBOOK or SAMPLES namespace rows.

Delete a Namespace

You can delete a namespace, including all mappings associated with it:

Navigate to the [Home] > [Configuration] > [Namespaces] page, and click Delete in the row of the namespace you want to delete.
On the Delete Namespaces page, if you want to delete the CSP pages from the physical path, select the check box.
To delete the namespace and associated mappings, click Perform Action Now.

Configuring Databases

A database is a cache.dat file you create using the Database Wizard. A Caché database holds data in multidimensional arrays called globals and executable content called routines, as well as class and table definitions. Globals and routines encompass such things as methods, classes, Web pages (CSP and HTML), SQL, BASIC, and JavaScript files.

Caché databases dynamically expand as needed, though you can set a maximum limit. Secondary volumes (extents) of a database are called cache.ext files. Caché automatically mounts the databases, which can grow to be 32 terabytes if you are using the default 8-KB block size.

The theoretical maximum for the number of Caché databases is 15,998. However, you can only have open at one time as many as permitted by the operating system limit on maximum open files (either per process or system-wide), minus what Caché reserves for its own use and device, which is approximately half.

You can make most database configuration changes dynamically; you can create, delete, or modify database attributes while the system is running. You can create new databases with an 8-KB block size; you can also create 2-KB databases for backward compatibility with versions of Caché prior to release 4.1.

Caché provides wizards for both local and remote database creation. Each is described in the following sections:

Considering Endianness

If you are defining a database using an existing cache.dat that was transferred from another platform, you must take Endianness — which defines the order in which multi-byte data is stored — into account. Depending on the platform (see “Platform Endianness” in Supported Platforms), multi-byte data is stored either with the most-significant byte, or the least-significant byte, in the lowest memory address (that is, first): when the most-significant byte is stored first, it is referred to as “Big-endian;” when the least-significant byte is stored first, it is referred to as “Little-endian.” If the cache.dat was created on a platform whose Endianness is different from the platform you are using, use the cvendian utility (see the Using cvendian to Convert Between Big-endian and Little-endian Systems article) to convert the database before you use it.

Considering Large Block Sizes

In addition to 2-KB and 8-KB (default) block sizes supported by Caché, you can use the following block sizes:

4 KB (4096)
16 KB (16384)
32 KB (32768)
64 KB (65536)

However, you should exercise caution when creating your database to use non-standard/large block size because using them can impact the performance of the system. Consider the following before enabling and using non-standard block sizes:

If your application workload consists primarily of sequential inserts or sequential reads/queries, large block sizes may improve performance.
If your application workload consists primarily of random inserts or random reads/queries, large block sizes may degrade performance. Since larger block sizes result in fewer blocks being cached for a given total size of database cache, to reduce the impact on random database access, you should also consider making more total memory available as database cache.
For index-type databases, the default block size (8 KB) ensures optimum performance; larger block sizes potentially degrade performance. If you are considering larger block sizes for your data, you should consider mapping index globals to a separate 8-KB block size database.

To create a database that uses block sizes other than the supported (2-KB and 8-KB) blocks, do the following:

Enable the block sizes with the DBSizesAllowed setting on the [Home] > [Configuration] > [Startup Settings] page.

Caution:
Do not remove the 8192 entry from the field; 8192 is the default block size used for all default/internal databases.
Configure shared memory for the enabled block size by editing the globals setting in the cache.cpf file (see the “Introduction to the Caché Parameter File” chapter in the Caché Parameter File Reference manual).
Restart Caché.
Create the database as described in Create Local Databases in this chapter.

Local Databases

The Local Databases page displays the following information about the databases on your system:

Name — Database name.
Mirror — If the database is mirrored, the name of the mirror; for more information see Configure Databases for Mirrors in the “Mirroring” chapter of the Caché High Availability Guide.
Directory — Location of the database.
Size (MB) — Size of the database in megabytes.
Status — Specifies whether or not the database is mounted, unmounted, or dismounted; if it is mounted, specifies whether it has read-only or read-write permission. For more information, see The Local Databases List Information table in Maintaining Local Databases in the “Managing Caché ” chapter of this guide.
Resource Name — The name of the database resource that governs access to the database; for more information, see the “Assets and Resources” chapter in the Caché System Security Guide.
Encrypted — Specifies whether or not the database is encrypted; for more information, see the “Database Encryption” chapter in the Caché System Security Guide.
Journal Specifies whether or not the database is journaled; for more information, see the “Journaling” chapter of the Caché Data Integrity Guide.

In addition, the page includes links to do the following:

Create New Database
Edit Database Properties
Delete a Database — Click Delete in the appropriate row to delete the selected database configuration.
View Global Data — Click Globals in the appropriate row to view the defined globals in the selected database and their contents.

Create Local Databases

To create a local database, navigate to the [Home] > [Configuration] > [Local Databases] page of the System Management Portal.

Click Create New Database to open the Database Wizard.
Enter the following information for the new database:
- Enter a database name in the text box. Database names must be at least one character (but not more than 30 characters) long. They can start with an alphabetic character or an underscore; the remaining characters must be alphanumeric, dashes, or underscores.
- Enter a directory name or click Browse to select a database directory. If this is the first database you are creating, you must browse to the parent directory in which you want to create the database; if you created other databases, the default database directory is the parent directory of the last database you created.
  
  Important:
  Caché does not support logical names for database directories on OpenVMS systems.
- If encryption is activated, you may encrypt this database by selecting the Encrypt Database check box.
Click Next to continue configuring the database or Finish to accept the defaults
In the Initial Size text box, type the number of megabytes for your database size (the default is 1 MB).
Select the desired block size from the Block size for this database will be drop-down list. By default, all new databases are created with a Block Size of 8 KB.

Caution:
Do not select block sizes other than 2 KB or 8 KB from the drop-down list unless you have read and understand the guidelines described in “Considering Large Block Sizes” in the Configuring Databases section of this chapter.
Click Next.
Choose the resource to control access to this database:
- Default — %DB_%DEFAULT
- Existing — Choose from a list of existing database resources
- New — Create a new database resource (the new name defaults to %DB_%database name)
Click Next to view a list of the database attributes.
Click Finish to add your database.

You are now ready to configure and manage your new database.

Note:

To protect you from accidentally corrupting a database, you cannot open or write to an operating system file called cache.dat or cache.ext, even if it is not a mounted database.

Edit Local Database Properties

The information displayed varies depending on whether or not the database is mirrored. This section identifies the fields for:

Edit Non-Mirrored Local Database Properties

Click Edit in the row of a non-mirrored database to view and change the following database properties:

Name
Directory
Encrypted
Mirrored (available only on primary mirror member, if mirroring is enabled).
Block Size (Bytes)
Size (MB)
Maximum Size (MB) — 0 for Unlimited
Expansion Size (MB) — 0 for Default
Resource Name
Global Journal State
New Global Collation
New Global Growth Block
New Global Pointer Block
Stream Location — Click Browse to select the directory in which streams associated with this database are stored. By default, the stream location for a local databases is a subdirectory named stream in the install-dir \Mgr\directory identified at the beginning of this database properties page (for example, install-dir \Mgr\directory \stream).

Note:
InterSystems recommends that you use the default location.
Preserve global attributes on delete
Read Only
Mount Required at Startup — Select Yes from the drop-down list to indicate that the database must be mounted when Caché starts up; if the database cannot be mounted, Caché will not start. Select No to let Caché start without first mounting the database.

Note:
By default, this setting is Yes for required Caché databases (for example, CACHESYS, CACHELIB, CACHETEMP, and CACHE); in these cases, the setting cannot be changed. The default setting is No for databases that you create, as well as some Caché databases (for example, USER and SAMPLES). For additional information about database status and explicitly dismounting and mounting databases, see The Local Databases List Information table in Maintaining Local Databases in the “Managing Caché ” chapter of this guide.
Mount Clustered at Startup — Select this check box to mount the cluster databases at startup.

Note:
This prompt displays only if this is a clustered system. For additional information, see Mounting Databases in the “Caché Cluster Management” chapter of this guide.

The “Create a Local Database” section describes many of these fields.

Edit Mirrored Local Database Properties

Click Edit in the row of a mirrored database to view and change the following database properties:

Name
Mirror Name
Directory
Encrypted
Stream Location — Click Browse to select the directory in which streams associated with this database are stored. By default, the stream location for a local databases is a subdirectory named stream in the install-dir \Mgr\directory identified at the beginning of this database properties page (for example, install-dir \Mgr\directory \stream).

Note:
InterSystems recommends that you use the default location.
Resource Name
Block Size (Bytes)
New Global Collation
Preserve global attributes on delete
Mount Required at Startup — Select Yes from the drop-down list to indicate that the database must be mounted when Caché starts up; if the database cannot be mounted, Caché will not start. Select No to let Caché start without first mounting the database.

Note:
By default, this setting is Yes for required Caché databases (for example, CACHESYS, CACHELIB, CACHETEMP, and CACHE); in these cases, the setting cannot be changed. The default setting is No for databases that you create, as well as some Caché databases (for example, USER and SAMPLES). For additional information about database status and explicitly dismounting and mounting databases, see The Local Databases List Information table in Maintaining Local Databases in the “Managing Caché ” chapter of this guide.
Size (MB) (listed for both failover members)
Maximum Size (MB) (listed for both failover members) — 0 for Unlimited
Expansion Size (MB) (listed for both failover members) — 0 for Default

Remote Databases

A remote database is a database that is physically located on another server system, as opposed to a local database which is physically located on the local server system.

From the Remote Databases page you can perform the following tasks:

Create Remote Database
Add Remote Database
Edit Remote Database Properties
Delete a Remote Database — Click Delete in the appropriate row to delete the selected database configuration.

Create Remote Database

To define a remote database on the local server, perform the following steps:

If you have not defined the remote server on this instance of Caché, navigate to the [Home] > [Configuration] > [ECP Settings] page of the System Management Portal.
Click Add Remote Data Server and enter the following information for the ECP remote data server:
1. Server Name — Enter a logical name for the convenience of the application system administrator.
2. Host DNS Name or IP Address — Specify the host name either as a raw IP address (in dotted-decimal format or, if IPv6 is enabled, in colon-separated format) or as the Domain Name System (DNS) name of the remote host. If you use the DNS name, it resolves to an actual IP address each time the application server initiates a connection to that ECP data server host. For more information about IPv6 addressing, see the IPv6 Support section in this chapter.
3. IP Port — The port number defaults to 1972; change it as necessary to the superserver port of the Caché instance on the remote server.
Click Save.
In the list of remote servers, verify the status is Normal. If it is not, click Change Status and change the status to Normal.
Navigate to the [Home] > [Configuration] > [Remote Databases] page of the System Management Portal.
Click Create New Remote Database to invoke the Database Wizard, which displays a list of the logical names (the name you used when you added it to the list of ECP data servers) of the remote servers on the local server.
Click the name of the appropriate server and click Next.
The portal displays a list of database directories on the remote server. Select one of these to serve as the remote database.
Enter a database name (its name on the local server; it does not need to match its name on the remote server) and click Finish. You have defined a remote database.

Database names are between 1 and 30 characters long, can start with an alphabetic character or an underscore. The remaining characters can be alphanumeric, a dash, or an underscore.

Add Remote Database

You can also define a remote database by entering your own remote server and directory. The portal does not validate your input for the following entries:

Database Name
Remote Server
Remote Directory

Once you add a remote database, you can edit its properties or delete it.

Edit Remote Database Properties

Click Edit to view and change the following database properties:

Database Name
Remote Server — Click the Available Servers drop-down to change the remote server where the database resides.
Remote Directory — Click the Available Directories drop-down to change the directory on the remote server where the database resides.
Stream Location — Click Browse to select the directory in which streams associated with this database are stored. By default, the stream location for a remote database is the Caché Temp directory (install-dir \Mgr\Temp) directory.

Note:
InterSystems recommends that you use the default location.

The Create Remote Database section describes many of these fields.

Configuring System Information

Caché stores system-wide configuration information in a configuration file. By default, the file is stored in the Caché root directory with the .cpf file extension. Caché initially starts with the provided configuration file called cache.cpf. In most cases, this configuration file is the only one you need to use Caché.

There are a few Memory and Startup Settings you may want to review on a new installation.

There are also a variety of advanced options available; however, these topics are not critical to running most Caché systems. These advanced options are described in various Caché topic-specific guides and reference books that you can access from the documentation home page. See the Caché Parameter File Reference for more information on the .cpf file.

Memory and Startup Settings

When you first install Caché, you may change some default system information. The [Home] > [Configuration] > [Memory and Startup] page of the System Management Portal provides an interface to the database allocation features, as well as a few startup settings:

You can choose whether to configure memory automatically or manually.

If you choose Automatically, the system allocates the amount of memory best suited to Caché given the available memory.

If you choose Manually, you can specify how global buffer pool memory is allocated:
- Memory allocated for Routine Cache (MB) — System memory allocated and used for caching server code.
- Memory allocated for 2-KB Database Cache (MB) — System memory allocated and used for buffering data for legacy 2-KB databases.
- Memory allocated for 8-KB Database Cache (MB) — System memory allocated and used for buffering data for 8-KB databases
See the Memory Support section for details.
You can set your Caché instance to start automatically when the system starts by selecting the Auto-start on System Boot check box.

Note:
The Auto-start on System Boot check box is selected by default. If you do not want the instance of Caché to start automatically on system boot, clear the check box.
If you select the Enable Long Strings check box, Caché allocates a large string stack to handle long strings for each process.
You can change the Superserver Port Number (TCP port used to accept incoming client requests) for this Caché instance.
Click Save to save your modifications; restart Caché to activate them.

Some changes on this page require a Caché restart and some do not. If you modify a field that requires a restart, no changes — even those that normally do not require a restart — to your configuration take effect until you restart Caché.

Important:

If you have made changes system-wide to the configuration settings that require a Caché restart, you receive the following:

Modification saved. You must restart system for the new values to take effect.

After you close the page, the warning message does not appear again to remind you that a restart is required.

Memory Support

Caché allocates half the space specified by routines to a pool of 64-KB buffers, three-eighths of the space for a pool of 16-KB buffers, and one-eighth of the space for a pool of 4KB buffers.

The maximum number of buffers allocated to any pool is limited to 65,529. Caché also never allocates fewer than 205 buffers to any sized pool. This means the actual memory used for routine buffers can be larger than specified in the configuration file. The format for Caché routines does not allow more than 32,768 characters for literal strings regardless of the setting for the maximum routine size.

Important:

If you are configuring a large ECP system, allocate at least 50 MB of 8-KB buffers for ECP control structures in addition to the 8-KB buffers required to serve your 8-KB blocks over ECP. See the Memory Use on Large ECP Systems section of the “Developing Distributed Applications” chapter of the Caché Distributed Data Management Guide for details.

IPv6 Support

When IPv6 is enabled, Caché accepts IPv6 addresses, IPv4 addresses, or DNS forms of addressing (host names, with or without domain qualifiers); when IPv6 is disabled, Caché accepts only IPv4 addresses or DNS forms of addressing.

When dotted-decimal IPv4 addresses (for example, 192.29.233.19) are specified, an IPv4 connection is attempted; when colon-separated IPv6 addresses (for example, 2001:fecd:ba23:cd1f:dcb1:1010:9234:4085) are specified, an IPv6 connection is attempted. When a DNS name (for example, mycomputer.myorg.com) is specified, it resolves to an actual IP address: first, it attempts to make an IPv4 connection; then, if an IPv4 connection cannot be made, it attempts an IPv6 connection.

For more information about IPv6 addressing, see IP Version 6 Addressing Architecture (RFC 4291) .

Important:

If Caché is running in an IPv6 or mixed network, the license server must be configured on a host running Caché 2009.1 or later; license servers running in Caché 5.1 through Caché 2008.2 do not accept IPv6 connections. See the Configure License Servers section in the “Managing Caché Licensing” chapter of the Caché System Administration Guide.

Configuring Task Manager Email Settings

From the [Home] > [Configuration] > [Task Manager E-mail Settings] page of the System Management Portal you can Configure Email Settings the Task Manager uses for notification.

For more information, see “Task Manager Email Settings” in the of Caché Additional Configuration Settings Reference.

Configure Email Settings

From the [Home] > [Configuration] > [Task Manager E-mail Settings] page you can configure email settings the Task Manager uses for notification. Fill in the necessary information from your particular mail server for the following fields:

SMTP Server — address of your outgoing SMTP (Simple Mail Transfer Protocol) mail server
SMTP Auth User and Password — Only required for SMTP authentication with the SMTP server. See RFC 2554 for details.
Sender — email address to appear in the sender field
Reply To — email address to which the recipient should reply

The following boxes contain suggested formats; you can change them as you wish:

Success Subject — The formatted subject line of a successful task message
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

Format the information in the subject and message text boxes using the task parameters listed at the bottom of the page and described in the following table.

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

Configuring NLS Settings

This release of Caché contains updated mechanisms for maintaining National Language Support (NLS) settings. The following sections describe the three ways to manage these settings:

Caution:

InterSystems provides both the [Home] > [Configuration] > [NLS Settings] page of the System Management Portal and the ^NLS routine for you to browse existing locales and tables and for you to create custom locales. Do not edit the system locales and tables (those in the InterSystems product distribution kit), as the next product update will overwrite any changes you make.

For more information, see “National Language Support Settings” in the of Caché Additional Configuration Settings Reference.

Using the NLS Settings Page of the System Management Portal

You can configure many NLS settings using the System Management Portal. The options are parallel to those in the ^NLS routine.

From the [Home] > [Configuration] page, click NLS Settings in the System Configuration column to display the [Home] > [Configuration] > [NLS Settings] page.

You have two menu options under the Locale Definitions column:

Locale Definitions

From the [Home] > [Configuration] > [NLS Settings] > [Locale Definitions] page, you can select a locale and perform several actions (the default of the locale field is always the current locale). Click the appropriate option in the following list:

Validate — Displays a message indicating the validation is successful or an appropriate error message if it is not.
Copy — Enter a locale name in which to create the copy. The new locale name must contain four characters beginning with y and ending with 8 or w. The default description is Copy of %locale, where %locale is the selected locale name. Click OK to add the copy to the drop-down list of locale names or Cancel to close the dialog box and return to the Locale Definitions page.
Export — Enter the file name to receive the export; it must be an .xml file. The default name is loc_%locale.xml, where %locale is the selected locale. In addition, you can include the pathname where you want to save the export file; if you do not specify the pathname, the default location is install-dir \Mgr directory. Click OK to export the .xml file or Cancel to close the dialog box and return to the Locale Definitions page.
Install — Select a locale to install that is different from the current locale. An initial validation occurs. If it fails, an error message displays; if it succeeds click Yes - Install Now or Cancel to close the dialog box and return to the Locale Definitions page. You can still install the locale if only a warning is displayed.
Load Table — Select a table type and then a table name from the list populated after you select the type. Click OK to load the table or Cancel to close the dialog box and return to the Locale Definitions page.
Delete — Disabled if the selected locale is the current locale. If you select another locale, a confirmation displays. Click OK to confirm that you want to delete the locale or Cancel to cancel the request and return to the Locale Definitions page.

To view and edit details of a selected locale, click Properties. The next page displays the locale properties grouped into categories. For each category you can edit the fields and click Save, or click 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:

Basic Properties
Date, Time, and Number Formats
Internal Tables — You have two options when editing the internal tables:
- Edit Tables — You may select or delete a table from the list boxes by double clicking an item, or by selecting an item and then clicking the > or < to move it from the appropriate list.
  
  Tables that require at least one entry are indicated by an asterisk (*); the other tables may be left empty.
- Edit Defaults — You may choose the default from the values you enter in the Edit Tables function of the Internal Tables category.
Input/Output Tables — You can edit, add, or remove a table when choosing to edit this category.
- To edit a table, click the table in the first list. The table name appears in the lower box. You can modify the values and click Save.
- To remove a table, click the table in the first list. The table name appears in the lower box; click Remove. A confirmation box displays offering you the option to Cancel or OK the delete.
- To add a table, click Add. The lower box has the Table field enabled and the Remove option disabled. You can enter a table name and enter the Output to and Input from fields.
Click Save when you have made all your updates. If the save is successful, the updated list appears; otherwise, an appropriate error message displays.
Input/Output Defaults
Strings

Import Locale

From the [Home] > [Configuration] > [NLS Settings] > [Import Locale] page, you can import locales or tables:

Select the Import Type; Locale is the default.
Enter a file name and click OK. The only valid file extensions are .xml and .goq.
A message displays indicating how many locales, tables, and subtables have been imported.

Using the ^NLS Routine

Invoke the ^NLS routine from the %SYS namespace:

 Do ^NLS

Follow the series of menus to perform the various functions in managing the NLS locales and tables. The following is an example of using the routine to display the current locale:

%SYS>Do ^NLS
 
 
1) Locale definitions
2) Table definitions
3) Import Locales/Tables
4) Current system settings
 
NLS option? 1
 
Select a locale: enuw => English, United States, Unicode
 
1) Display locale
2) Edit locale
3) Install locale
4) Export locale
5) Validate locale
6) Copy locale
7) Delete locale
8) Load locale table
9) Select another locale
 
Locale option? 1
Number of lines for paging (0=don't page):  24 => 0
 
--------------------------------- Locale enuw --------------------------------
         Country: United States (US)         Language: English (en-US)
   Character set: Unicode                    Currency: $
 
Internal tables --  Default --------  Additional -----------------------------
Pattern match       Latin1
Identifier          Latin1
Uppercase           Latin1
Lowercase           Latin1
Titlecase           Latin1
Collation           Cache standard
$X/$Y action        Latin1
 
Input/output tables ----------------------------------------------------------
     CP1250      CP1251      CP1252      CP1253      CP1255      CP866
     CP874       Latin2      Latin9      LatinC      LatinG      LatinH
     LatinT
 
I/O defaults -----------------------------------------------------------------
                  Process: RAW                   TCP/IP: RAW
           Cache Terminal: UTF8          Other terminal: RAW
                     File: RAW              System call: RAW
                  Magtape: RAW                  Printer: RAW
 
------ Date ------------- Time --------------------- Numbers -----------------
     Format: 1          Format: 1       Minus sign: -     Decimal separator: .
  Separator: /       Separator: :        Plus sign: +       Group separator: ,
                     Precision: 0                                Group size: 3
 
Strings ----------------------------------------------------------------------
 
  Time -----------------------------------------------------------------------
       AM: AM                          Noon: NOON
       PM: PM                      Midnight: MIDNIGHT
 
  Week days ------------------------------------------------------------------
       Names:  Sunday Monday Tuesday Wednesday Thursday Friday Saturday
       Abbrv:  Sun Mon Tue Wed Thu Fri Sat
 
  Months ---------------------------------------------------------------------
       Names:  January February March April May June July August September ...
       Abbrv:  Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
------------------------------------------------------------------------------
 
1) Display locale
2) Edit locale
3) Install locale
4) Export locale
5) Validate locale
6) Copy locale
7) Delete locale
8) Load locale table

Using the NLS Class Packages

The System Classes For National Language Support article contains details on using both the %SYS.NLS and Config.NLS class packages.

The %SYS.NLS Classes section contains details on using the following classes:

%SYS.NLS.Device — Properties of the current device.
%SYS.NLS.Format — Date, time, and number formats.
%SYS.NLS.Locale — Basic properties of current locale (read-only).
%SYS.NLS.Table — System and process tables (I/O and internal).

The Config.NLS Classes section contains details on using the following classes:

You can also find details on each of these classes in the Caché Class Reference.

Cluster Settings

These settings apply only to platforms that support clusters (for example, OpenVMS or Tru64). It does not automatically force a system to join a cluster. A system joins a cluster automatically the first time it mounts a database for clustered access.

The connection is automatically configured and the cluster members do not need to be listed as clients of each other. The only requirement is that if the machine has multiple IP addresses (generally because there are multiple network interface cards) you must set the CommIPAddress to force Caché to use a specific IP address for the cluster ECP traffic.

The following settings appear in the Cluster Settings category on the [Home] > [Configuration] > [Cluster Settings] page:

JoinCluster — True or false. When true, this configuration is part of a cluster and the appropriate cluster definition settings can be configured. The default is false.
CommIPAddr — IP Address to advertise in the PIJ to other cluster members to use for inter-cluster communication. The string, which may be up to 128 characters long (a cluster feature), is a resolvable DNS name or IP address.
pijdir — The pre-image journal (PIJ ) file to support cluster failover, recovery, and write image journaling in a cluster.

If you edit this setting, you must restart Caché to apply the change.

For more information, see “Configuring Caché Clusters” in the Caché System Administration Guide.

Zen Report Settings

From the [Home] > [Configuration] > [Zen Report Settings] page you can configure and verify Zen report settings:

Path and file name to be used for PDF generation: — Click Browse to locate the command file that invokes the third-party rendering tool that Caché uses to create PDF output. Examples are RenderX XEP and Apache FOP.
Verify Now — Click this button to test whether or not the rendering tool is configured correctly.

For more information, see “Zen Report Settings” in the Caché Additional Configuration Settings Reference.