The 99Local.xml and 100Custom.xml configuration files
Many default IBM Process Server configuration settings are saved in the 99Local.xml file; the 100Custom.xml file is used to modify one or more of those default settings. Both files are stored in the profile root for the server.
Although the documentation discusses 99Local.xml and 100Custom.xml, remember that there are other configuration files as you plan and make configuration changes.
When you modify a server configuration, always make the changes to the 100Custom.xml file, not to the original configuration file. In this way, all customizations are captured in a single file and are readily available if you upgrade to a new version of IBM® Business Process Manager.
Value for merge attribute | Description |
---|---|
append | Appends the new element after any existing elements. |
mergeChildren | Merges the new element with the first of the existing elements. This is the default behavior, which means that the attribute merge="mergeChildren" is implied and does not actually need to be specified on an element. |
replace | Replaces all existing elements and their child
elements with the new element. CAUTION: When you set the merge="replace" attribute
for an element that has nested child elements, any existing child
elements from the product's default configuration will be deleted
and only the child elements that are specified in your customization
will be set. Therefore, only use the merge="replace" attribute
with elements that have a list of nested child elements with the same
name. For other cases, only specify the merge="replace" attribute
for the individual child elements.
|
Locating configuration files
Path names to configuration files and other resources in the following topics are specific to the server you are configuring. For example, the 100Custom.xml and 99Local.xml files are stored in the profile root for the server, where the value of server_type is either process-center or process-server, depending on which server you are configuring.
In addition, the location of the configuration files depends on whether your environment is stand-alone or a clustered network deployment.
Environment type | Location of 99Local.xml file | Location of 100Custom.xml file |
---|---|---|
Stand-alone server |
|
|
Network deployment cluster | In the network deployment Process Server
cluster:
Each Process Server cluster
member at:
|
In the network deployment Process Server
cluster:
Note: For
ND environments, XML configuration files on the cluster level are templates for XML configuration
files that are created when new cluster members are added. Also, XML configuration files on the
cluster level are used by certain administrative commands that run in local mode, such as the
BPMUpdateSystemApp command.
Each
Process Server cluster member at:
Important: At run time,
only the settings from these cluster member files are read.
|
Making changes to configuration files for a network deployment cluster
For network deployment environments, XML configuration files on the cluster level are templates for XML configuration files that are created when new cluster members are added. If you make changes to the file at the cluster member level (dmgr_profile_root\config\cells\cell_name\nodes\custom_node_name\servers\cluster-member-name\server_type\config\100Custom.xml), make the changes at the cluster level as well (dmgr_profile_root\config\cells\cell_name\clusters\cluster_name\server_type\config\100Custom.xml). The 100Custom.xml file on the cluster level cannot contain node-specific settings or server-specific settings, such as host names. Making the changes to the templates at the cluster level ensures that the changes are also created on any new cluster member, if one is added in the future.
At run time, only the settings from the application server files are read. If you make changes after deployment, you need to make them in the cluster member version of the file for each server in order to have the changes take effect at run time.
- Make changes to the XML files for each cluster member.
- Make changes to the cluster level to ensure that each new cluster will be created with your customizations.
- After making the changes, select Full Resynchronize to replicate the settings from the deployment manager server to the individual nodes. If you edit these configuration files on an individual node, the changes may be lost in the next update.
Backing up configuration files
All of the files in the .../config directory that end in .xml are loaded when you start or restart the product. The XML files are loaded in a sequence where those starting with a letter of the alphabet are loaded before ones that start with numbers, which are loaded in numeric order. So any copies of XML configuration files that keep the .xml extension can cause unexpected behavior.
.../config/system/Copy of 99Local.xml
.../config/system/00Static.xml
.../config/system/50AppServer.xml
.../config/system/60Database.xml
.../config/system/80EventManager.xml
.../config/system/98Database.xml
.../config/system/99Local.xml
.../config/100Custom.xml
In this example,
the possibly old settings in the Copy of 99Local.xml file
take effect first and all settings in the 99Local.xml file
are ignored - except for elements that include the attribute merge="replace".