Running CAE utilities
cae_migrate_tool_configuration
Prior to Teamcenter 10.1.3, configured simulation tools were managed in the database in an XML file. From 10.1.3, simulation tools are managed in the database as individual business objects, and, therefore, you must migrate simulation tools when you to upgrade to Teamcenter 10.1.3 and beyond. After Teamcenter is migrated to a new version, you must run the cae_migrate_tool_configuration utility to migrate existing simulation tools. This utility: Migrates the simulation tool configuration from the espf_configuration.xml file stored in the dataset identified by the CAE_simulation_tool_config_dsname preference. Imports the simulation tool configuration structure from the PLM XML .xml file at the target site. Exports the simulation tool configuration structure to the PLM XML .xml file at the source site. Note Non DBA users must use the -setRootToolByPass option for migration or import operations. If you want to export the unreleased tool BOM by using the cae_migrate_tool_configuration utility, set the value of the PSEShowUnconfigdEffPref preference to true. Syntax cae_migrate_tool_configuration [-u=dba_user] [-p=password] [-pf=password-file] [-g=dba] [-ou=owning-user-id] [-og=owning-group-name] [-mode=export-or-import] [-folder=folder-name] [-fileName=PLM-XML-file] [-lwofilename=ESPF-XML-file] [-item_id=root-simulation-item-id] [-rev=root-simulation-tool-item-rev-id] [-rev_rule=revision-rule] [-autorelease=auto-release-indicator] [-setRootToolByPass=bypass-root-simulation-tool-setting] [-h=displays-command-line-help] Arguments -u Specifies the user ID. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -ou Specifies the owning user ID. This user owns all created objects. This option is used only to migrate tool configuration from the XML file stored in the dataset. -og Specifies the group associated with the owning user. Note If you specify the -ou argument and do not specify the -og argument, the user’s default group is used. -mode=EXPORT | IMPORT Specifies the mode of this utility. If this option is not used, this utility migrates the tool configuration from the XML file stored in the dataset identified by the CAE_simulation_tool_config_dsname preference. -mode=EXPORT Exports the simulation tool structure in PLM XML format (.xml file) from the source site. -mode=IMPORT Imports the simulation tool structure in PLM XML format (.xml file) from the target site. -folder=folder-name Specifies the folder where the PLM XML and ESPF XML files are created. Required only for PLM XML mode of operation. -fileName=PLM XML file -mode=EXPORT Specifies the PLM XML (.xml) file that contains information about the Simulation Tool structure you want to export. -mode=IMPORT Specifies the PLM XML (.xml) file that contains information about the Simulation Tool structure you want to import. -lwofilename=ESPF-XML-file -mode=EXPORT Specifies the PLM XML (.xml) file that contains information about the LWOs in the simulation tool structure you want to export. -mode=IMPORT Specifies the PLM XML (.xml) file contains information about the LWOs in the simulation tool structure that needs to be imported. -item_id=root-simulation-tool-item-id Specify the item id of root simulation tool. -rev=root-simulation-tool-item-rev-id Specifies the item revision id of root simulation tool. This is required only for the PLM XML mode of operation. -rev_rule=revision-rule Specifies the revision rule to configure the tool structure. If not specified, the default revision rule is used. This is applicable for the PLM XML mode of operation. -autorelease=auto-release-indicator Releases the simulation tool structure after the import operation using the PLM XML mode of operation. -setRootToolByPass Bypasses the setting of the root simulation tool UID to the preference value to import or migrate from the XML file. Note If this option is not used, the utility sets the root simulation tool to the preference value. -h Displays help for this utility. Examples Migrate the simulation tool configuration (espf_configuration.xml) file to the simulation tool structure and configure the simulation root tool. cae_migrate_tool_configuration -u=dba_user -p=password -g=dba –ou=owning-user-id Migrate the legacy tool configuration (espf_configuration.xml file) to the simulation tool structure, but do not configure the simulation root tool. cae_migrate_tool_configuration -u=dba_user -p=password -g=dba –ou=owning-user-id -setRootToolByPass Export the simulation tool configuration structure to the PLM XML (.xml) file using the default revision rule. cae_migrate_tool_configuration -u=dba_user -p=password -g=dba -mode=EXPORT -folder=D:\Import-export\example_plmxml_folder -item_id=000082-rev=A Export the simulation tool configuration structure to the PLM XML (.xml) file, using the Any Status; Working revision rule. cae_migrate_tool_configuration -u=dba_user -p=password -g=dba -mode=EXPORT -folder=D:\Import-export\example_plmxml_folder -item_id=000082-rev=A -rev_rule=Any Status; Working Import the simulation tool configuration structure from the PLM XML (.xml) file, using the default revision rule with the simulation administrator as the owning user, but do not configure the simulation root tool. cae_migrate_tool_configuration -u=dba_user -p=password -g=simulation administrator -mode=IMPORT -folder=D:\Import-export\example_plmxml_folder -item_id=000082-rev=A –ou=owning-user-id -setRootToolByPass Import the simulation tool configuration structure from the PLM XML (.xml) file, using the default revision rule, and release the structure after import, but do not configure the simulation root tool. cae_migrate_tool_configuration -u=dba_user -p=password -g=DBA -mode=IMPORT -folder=D:\Import-export\example_plmxml_folder -item_id=000082-rev=A –autorelease -setRootToolByPass Import the simulation tool configuration structure from the PLM XML (.xml) target site, release the structure, and configure the simulation root tool. cae_migrate_tool_configuration -u=dba_user -p=password -g=DBA -mode=IMPORT -folder=D:\Import-export\example_plmxml_folder -item_id=000082-rev=A –autorelease Related Topics Simulation Process and Data Management on Rich Client ─ Usage
Source: https://docs.sw.siemens.com/documentation/external/PL20251212545240207/en-US/tc_help/utilities_reference/ovy1737253716650/xid924928.html · retrieved Fri Jul 31 2026 00:00:00 GMT+0000 (Coordinated Universal Time)