plmxml_import

Imports objects to Teamcenter from a specified PLM XML file. In cases where a transfer mode manages the import, the utility looks for files in the path specified by the xml_file argument. This utility is also used to import workflow templates. If the PLM XML file being imported contains translations of localizable properties in multiple languages, the translations of the supported languages are imported into the database. Caution Do not use this utility to import organization objects to sites if the same organization objects are shared through a global organization. Warning The Business Modeler IDE application maintains most of the objects that affect the data model. Do not import the following objects. Importing the generated PLM XML file using the plmxml_import utility may cause data accuracy issues. AliasTypeDef GRMRule ProcessTypeDef ApplicationInterface HideTypeRule (Type-Display rule) PropBusinessOperation AppearenceGroupTypeDef IdContextRule RelationTypeDef ActivityTypeDef ImanTypeDef StatusTypeDef CannedMethodRule ItemTypeDef StorageMediaTypeDef ChangeTypeDef ListOfValues ToolTypeDef CompoundPropDefRule NamingRule TypeBusinessOperation DatasetTypeDef NameFieldRule UOMTypeDef DeepCopyRule NoteTypeDef ViewTypeDef Extension OccurrenceTypeDef WorkAreaTypeDef FolderTypeDef OperationTypeDef FormTypeDef PropertyRule Syntax plmxml_import [-u=user-id {-p=password | -pf=password-file} -g=group] -xml_file=name-of-xml-file -transfermode=transfermode-name [-log=log-file-name] [-import_mode=overwrite | ignore] [{-apply_template | -ignore_originid}] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. 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. -xml_file Specifies the full path of the file name from which the data is imported. If the PLM XML was exported using Active Workspace, first unzip the file containing the exported PLM XML. -transfermode Specifies the name of a transfer mode used to import the objects. This transfer mode specifies the traversal rules, filter rules, and property sets to be used for import. It determines what is imported from the system. If not specified, a default transfer mode is used. In addition, the following transfer mode values can be applied to import workflow templates. workflow_template_import Use to create a new template. If the template already exists in the database, the command is ignored. workflow_template_overwrite Use to overwrite an existing workflow template. The version existing in the database is overwritten by the imported version. If the workflow template does not already exist, a new workflow template is created. -log Specifies the full path of the import log file. If this option not specified, the log file is created in the $TC_TMP_DIR directory. If $TC_TMP_DIR is not defined, the log file is created in the system temporary directory (C:\TEMP on Windows or /tmp on Linux). -import_mode Specifies the mode in which import is handled for PLM XML Import/Export configuration objects. In overwrite mode, objects that already exist in the database are overwritten. In ignore mode, the imported object is ignored if the imported object already exists in the database. The classes that function with this argument are: Teamcenter class name SDK class name TransferMode plmxml60::TransferMode ClosureRule plmxml60::ClosureRule PropertySet plmxml60:: PropertySet Filter plmxml60::FilterRule PIEActionRule Exported as UserData under plmxml60::TransferMode Person plmxml60::Person TCCalendar plmxml60::Calendar User plmxml60::User Group plmxml60::Organisation Discipline plmxml60::Discipline Role plmxml60::Role POM_imc plmxml60::Site RevisionRule plmxml60::RevisionRule ListOfValues plmxml60::ListOfValues ImanQuery plmxml60::SavedQueryDef -apply_template When you specify the workflow_template_overwrite transfer mode, and the imported workflow template contains changes from the existing workflow template, this argument applies those changes to all active workflow processes based on the workflow template. When you import templates from a Teamcenter version prior to 10.1, do not use the -apply_template argument. If you do, Teamcenter does not successfully import the template. For more information about how the workflow template changes are applied, see Workflow Designer on Rich Client. This argument must be used with the workflow_template_overwrite transfer mode. The -apply_template and -ignore_originid arguments are mutually exclusive. -ignore_originid Prevents the check of the origin_id property and forces the imported workflow template to overwrite the current one. Changes to active workflow processes are not applied. The -apply_template and -ignore_originid arguments are mutually exclusive. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions Siemens Digital Industries Software recommends you do not use the following transfer modes with this utility: JTDataImportDefault TIEImportDefault Do not use this utility to export organization objects to sites if the same organization objects are shared through a global organization. Examples The following command imports all objects in the abc.xml file using the default context: Copy plmxml_import -u=Tc-admin-user -p=password -g=group -xml_file=abc.xml If errors are detected during the import operation, a log file named abc_log.txt is created. The following command imports the wkf_templates.xml workflow template without overwriting existing templates: Copy plmxml_import -u=Tc-admin-user -p=password -g=group -xml_file=wkf_templates.xml -transfermode=workflow_template_import The following command imports the wkf_templates.xml workflow template that overwrites the existing wkf_templates.xml workflow template, creating an updated version of the template in the database: Copy plmxml_import -u=Tc-admin-user -p=password -g=group -xml_file=wkf_templates.xml -transfermode=workflow_template_overwrite The following command imports the wkf_templates.xml workflow template that overwrites the existing wkf_templates.xml workflow template, creating an updated version of the template in the database, and applies all changes from the imported version to all active workflow processes: Copy plmxml_import -u=Tc-admin-user -p=password -g=group -xml_file=wkf_templates.xml -transfermode=workflow_template_overwrite -apply_template Related Topics Transfer modes included with Teamcenter TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration