XML File Overview

The ConfigUpdater.xml file is the script where all the DELMIA Apriso configuration files changes should be specified.

Elements

The XML file contains the following elements:

Configuration – the root element
configFiles – the list of configuration files that will be changed
configFile – the single configuration file specification

path (attribute) – the name of the configuration file that should be updated

The path can contain the macro WwwRoot or ProgramFiles. The macro replaces part of the file's path.
You can also use Configuration Variables defined in the DeploymentInfo.xml file under <drive>\Program Files\Dassault Systemes\DELMIA Apriso 2021\Website\CentralConfiguration. For details, see High Availability Installation Guide.

actions – the list of all the actions that apply to this configuration file
action – the action definition

type (attribute) – the type of action. There can be four types of action: Add, Change, Remove or RemoveByComment
optional (attribute) – if set to true, ConfigUpdater returns the code even if an error in executing that action occurs

xPath – the name of the node specified as XPath. For more information about XPath, refer to XPath Specification available at the World Wide Web Consortium (W3C) website.
value – the new value of the node

evaluateExpression (attribute) – if set to true, the Configuration Variables can be used (for details, see DELMIA Apriso Administration Guide)

The value of the newly added key must be placed between these HTML entities: &lt node's value /&gt.

searchPattern – if specified (in the Change action), only all occurrences of the searchPattern in the old value are replaced with a content of the value node

regEx (attribute) – if set to true, the regular expression can be used as a searchPattern
ignoreCase (attribute) – if set to true, the letter case is ignored during the search

condition – if specified, the action is executed only if the condition is met

xPath (attribute) – the xPath (in that condition) to be checked
type (attribute) – the possible values are Exists or NotExists. If set to Exists, the specified xPath must be found in the config file

comment – if specified, the comment will be added above affected configuration node

evaluateExpression (attribute) – if set to true, special comment macros can be used:

$[CurrentDate]
$[CurrentDateAndTime]
$[Version] – the number of the last installed version including Service Pack
$[InstalationDate] – the date of the last Service Pack installation

readmeInfo – this node is for internal use only

Usage

This an example of the XML file usage:

<?xml version="1.0" encoding="utf-8"?>
<Configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<configFiles>
   <configFile path="${ProgramFilesPath}WebSite\CentralConfiguration\CentralConfiguration.xml" >
     <actions>
       <action type="Change">
         <xPath>//configuration/FlexNet.DataServices/add[@key='EntitiesAssemblies']/@value</xPath>
         <value>FlexNet.SystemServices, Version=10.0.0.0, Culture=neutral, PublicKeyToken=xxxxxxxxxxxxxxxx|FlexNet.Entities.Processes, Version=10.0.0.0, Culture=neutral, PublicKeyToken=xxxxxxxxxxxxxxxx</value>
       </action>
       <action type="Add">
         <xPath>//configuration/FlexNet.DataServices</xPath>
         <value><add key="Foo" value="Bar" /></value>
         <comment evaluateExpression="true">This key has been added at $[CurrentDateAndTime]</comment>
       </action>
       <action type="Remove" optional="true">
         <condition xPath="/configuration/FlexNet.DataServices/add[@key='UseAdvancedConnectionSettings' and @value='False']" type="Exists" />
         <xPath>/configuration/FlexNet.DataServices/add[@key='UseAdvancedConnectionSettings']</xPath>
       </action>
      <action type="RemoveByComment" optional="true">
         <condition xPath="/configuration/FlexNet.DataServices/add[@key='UseStandardLoginUserID' and @value='False']" type="Exists" />
         <xPath>/configuration/FlexNet.DataServices/add[@key='UseStandardLoginUserID']</xPath>
        <comment evaluateExpression="true">This key has been removed at $[CurrentDateAndTime]</comment>
       </action>
     </actions>
   </configFile>
<configFile path="${ProgramFilesPath}WebSite\Portal\web.config">
     <actions>
       <action type="Change">
         <xPath>/configuration/appSettings/add[@key="CentralConfigurationFile"]/@value</xPath>
         <searchPattern regEx="true" ignoreCase="true">.+(?=\/CentralConfiguration\/)</searchPattern>
         <value evaluateExpression="true">${WebSitePath}</value>
       </action>
     </actions>
   </configFile>
</configFiles>
</Configuration>

The result will be that in the CentralConfiguration.xml file:

the node addkey= "EntitiesAssemblies" will be changed and the node's value will be set to: "FlexNet.SystemServices, Version=10.0.0.0, Culture=neutral, PublicKeyToken=xxxxxxxxxxxxxxxx|FlexNet.Entities.Processes, Version=10.0.0.0, Culture=neutral, PublicKeyToken=xxxxxxxxxxxxxxxx",
the new node <add key=”Foo” value=”Bar” /> with the following comment <!-- This key has been added at (replacement of date and time) --!> will be added to the FlexNet.DataServices section
the key with the name UseAdvancedConnectionSettings will be removed only if its value is set to false
the key UseStandardLoginUserID will be commented out and a new comment <!-- This key has been added at (replacement of date and time) --!> will be added to the FlexNet.DataServices section only if its value is set to false

The result in web.config file:

the key CentralConfigurationFile will be changed. All text before “CentralConfiguration” will be replaced with a current WebSitePath defined in the Deployment Info.xml file.