About Deploying the Configuration

Administrator users can define a configuration on a platform, validate the configured environment, and then deploy the same configuration by exporting an XML file containing all the configuration settings and importing it to another platform.

This page discusses:

About Exporting Configuration Settings

When you add user-defined attributes or modify other configuration settings, you can export these changes to an XML file. Exporting extracts the configured features from the database and generates an XML file that can be imported.

Important: You should not manually edit the XML file. Any changes could introduce errors making the file unusable.

When you export a configuration, the app saves a file named Parameterization_Export.xml with your modifications. The file uses this document type definition (DTD): 

<!ELEMENT TeamParameterization ( Parameter+ ) >
<!ATTLIST TeamParameterization date CDATA #REQUIRED >
<!ATTLIST TeamParameterization version NMTOKEN #REQUIRED >
<!ELEMENT Parameter( #PCDATA ) >
<!ATTLIST Parameter 
category ( AttributeDef | VpmCbpMapping | ObjectIdentifier |
DataAccessRight | VersionNaming | LifecycleMgnt ) #REQUIRED >
<!ATTLIST Parameter
name ( AddAttribute | ProdPartAttrMapping | IdentifierAffix |
VersionSequence | StrictVersioning | StrictOwnership |
RestrictTransfer | StrictLocking | ExtendViewer |
ExtendExperimenter | LCTransitionCheck ) #REQUIRED >
<!ATTLIST Parameter description CDATA #REQUIRED 
<!ATTLIST Parameter id CDATA #REQUIRED >

This example shows all configuration changes, including:

  • Part attributes
  • Product and Representation attributes
  • Synchronization relation
  • Content access rights parameters
  • Version naming parameters
  • Identifier interfix parameter
  • Lifecycle check parameters 

<? xml version="1.0" ?>
<TeamParameterization date="Thu Apr 14 08:40:45 CEST 2011" version="V6R2012x">
<Parameter id="Param_000001" category="AttributeDef" name="AddAttribute"
description="no description">
Part|String(16)|E_XParamStr16A|Supplier Id|Company1|Company1,Company2,FAM|FALSE|FALSE</Parameter> 
<Parameter id="Param_000002" category="AttributeDef" name="AddAttribute" 
description="no description">
ENOSTProductReference|String(16)|E_XParamStr16A|Supplier Name|Company1|Company1,Company2,FAM|FALSE|FALSE</Parameter>
<Parameter id="Param_000003" category="AttributeDef" name="AddAttribute" 
description="no description">
ENOSTRepresentation|Boolean|E_XParamBoolA|IsApproved|FALSE|True,False|TRUE|FALSE</Parameter>
<Parameter id="Param_000004" category="VpmCbpMapping" name="ProdPartAttrMapping" 
description="no description">Supplier Name|Supplier Id</Parameter> 
<Parameter id="Param_000005" category="DataAccessRight" name="ExtendExperimenter" 
description="no description">Enabled</Parameter>
<Parameter id="Param_000006" category="DataAccessRight" name="ExtendViewer" 
description="no description">Enabled</Parameter>
<Parameter id="Param_000007" category="DataAccessRight" name="StrictVersioning" 
description="no description">Disabled</Parameter> 
<Parameter id="Param_000008" category="DataAccessRight" name="StrictOwnership" 
description="no description">Disabled</Parameter>
<Parameter id="Param_000009" category="DataAccessRight" name="StrictLocking" 
description="no description">Enabled</Parameter>
<Parameter id="Param_000010" category="DataAccessRight" name="RestrictTransfer" 
description="no description">Enabled</Parameter> 
<Parameter id="Param_000011" category="VersionNaming" name="VersionSequence"
description="no description">DevelopmentPart|AlphabeticalRev</Parameter> 
<Parameter id="Param_000012" category="VersionNaming" name="VersionSequence"
description="no description">ProductionPart|NumericalRev</Parameter> 
<Parameter id="Param_000013" category="VersionNaming" name="VersionSequence"
description="no description">VPLM_SMB_Evaluation|DashedRev</Parameter> 
<Parameter id="Param_000014" category="VersionNaming" name="VersionSequence"
description="no description">VPLM_SMB_Definition|DashedRev</Parameter> 
<Parameter id="Param_000015" category="ObjectIdentifier" name="IdentifierAffix"
description="no description">TBD</Parameter> 
<Parameter id="Param_000016" category="LifecycleMgnt" name="LCTransitionCheck"
description="no description">
ENOSTLogicalReference|IN_WORK|FROZEN|RejectOnCreator|EleLogicalConnectorComp|</Parameter>
<Parameter id="Param_000017" category="LifecycleMgnt" name="LCTransitionCheck"
description="no description">
Part|Peer Review|Complete|RejectIfAnyOfTheCommonlyGovernedChildNotOnTargetState||PhysicalProduct</Parameter>
<Parameter id="Param_000018" category="LifecycleMgnt" name="LCTransitionCheck"
description="no description">
ENOSTProductReference|FROZEN|RELEASED|InconditionalReject||</Parameter>
<Parameter id="Param_000019" category="LifecycleMgnt" name="LCTransitionCheck"
description="no description">
ENOSTProductReference|IN_WORK|RELEASED|RejectIfAnyOfTheCommonlyGovernedChildNotOnTargetState||PhysicalProduct</Parameter>
</TeamParameterization>

About Importing a Configuration

Administrator users can import a configuration from an XML file that uses the same DTD described above.

The imported configuration could have different definitions for the attributes for an object type. When importing the configuration, the imported attributes are added to the existing attributes for that object type and no attributes are removed. If an attribute already exists, it is not updated.

For example, if the server currently has ATTRIB_1, ATTRIB_2, and ATTRIB_3, defined and the import includes ATTRIB_A and ATTRIB_C, the result is that the object type now has all of those attributes defined for it. If the server currently has ATTRIB_1, ATTRIB_2, and ATTRIB_3, defined and the import includes ATTRIB_1, the attribute definition for ATTRIB_1 is not updated based on the import and nothing happens to ATTRIB_2, and ATTRIB_3.

The imported configuration could have different definitions for maturity graphs. For example, the configuration being imported could have removed and added transitions to a maturity graph. When imported to a server that does not have those changes, the added transitions are imported but the removed transitions are not removed. This prevents corrupting any existing data.

You can import configurations successively from different XML files. The final state of configuration complies with the rules listed above (if conflicting settings are successively imported via XML files, only the one in the last file to be imported will be present in database).

If the import includes default values for attributes added to Product and Representation content types, those defaults are only used when executing one of these commands from a native app:

  • New
  • New Major Version
  • Advanced Duplicate
  • Import (CATIA File)

For other functions such as Import (3DXML), any default value is not set.