Skip to main content

CPF (Tools/APIs)

Modify the CPF programmatically (change settings such as memory and journal settings, define mappings, configure devices, and so on).

Background Information

The CPF (Configuration Parameter File) contains a set of parameters that affect how InterSystems IRIS® data platform operates. InterSystems IRIS reads this file for configuration settings when it starts up. For more information, see Introduction to the Configuration Parameter File.

The CPF can be modified programmatically through the configuration merge feature and a number of classes. Most individual settings can also be modified using the Management Portal.

Available Tools

configuration merge feature

The ISC_CPF_MERGE_FILE environment variable lets you specify a configuration merge file, which contains one or more configuration settings to be merged into the CPF with which a new instance is installed or deployed before the instance is first started. You can modify the configuration of an existing instance in similar fashion using the iris merge command or by setting ISC_CPF_MERGE_FILE when starting or restarting. The configuration merge feature supports the automated deployment of multiple differently-configured instances from the same source (container image or installation kit), as well as automated reconfiguration. For more information, see Automating Configuration of InterSystems IRIS with Configuration Merge.

Config package

Most of the classes in this package enable you to modify the CPF. Classes in this package include:

Many of these classes are persistent and many provide class queries.

Availability: %SYS namespace.

Provides the following method:

  • GetCPFFileName()

Availability: All namespaces.

FeedbackOpens in a new tab